• General
    • Automated Measurements Overview
    • System Requirements
    • Measurement Modes and Default Settings
  • Bode Automation Interface
    • Documentation
    • Command Reference
    • Changelog
  • SCPI
    • Documentation
    • Command Reference
    • Error Handling
    • Changelog

    Show / Hide Table of Contents
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface
      • Bode100
      • BodeAutomation
      • Calibration
      • CalibrationValues
      • CorrectionValues
      • FullRangeIsActiveChanged_Delegate
      • FullRangeIsAvailableChanged_Delegate
      • Results
      • UserRangeIsActiveChanged_Delegate
      • UserRangeIsAvailableChanged_Delegate
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.DataTypes
      • Complex
      • IComplex
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Enumerations
      • AngleUnit
      • Attenuator
      • CalibrationMultiModeToggle
      • Connection
      • ExecutionState
      • FResQFormats
      • LevelUnit
      • LogLevel
      • MagnitudeUnit
      • MeasurementTypes
      • ReceiverBandwidth
      • SourceMode
      • SweepMode
      • Termination
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces
      • Attenuation
      • BodeAutomationInterface
      • BodeDevice
      • DeviceConfiguration
      • DeviceProperties
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Calibration
      • FullLoadCalibrationValues
      • FullOpenCalibrationValues
      • FullShortCalibrationValues
      • FullThruCalibrationValues
      • GainCalibration
      • GainFullCalibrationValues
      • GainFullRange
      • GainUserCalibrationValues
      • GainUserRange
      • ImpedanceCalibration
      • ImpedanceFullCalibrationValues
      • ImpedanceFullRange
      • ImpedanceUserCalibrationValues
      • ImpedanceUserRange
      • InternalCalibration
      • MultiModeCalibration
      • MultiModeFullCalibrationValues
      • MultiModeFullRange
      • MultiModeUserCalibrationValues
      • MultiModeUserRange
      • UserLoadCalibrationValues
      • UserOpenCalibrationValues
      • UserShortCalibrationValues
      • UserThruCalibrationValues
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Measurements
      • AdapterMeasurement
      • ExternalBridgeMeasurement
      • GainMeasurement
      • Impedance
      • OnePortMeasurement
      • Reflection
      • S11ExternalCouplerMeasurement
      • S11OnePortMeasurement
      • S21Measurement
      • SeriesThruMeasurement
      • ShuntThruMeasurement
      • Transmission
      • VoltageCurrentGainMeasurement
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.PortExtension
      • CableLosses
      • PortExtension
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Results
      • AdmittanceResult
      • GainResults
      • ImpedanceResult
      • ReflectionResult
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Results.SpecialResults
      • OverloadResult
      • Vrms
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Shaping
      • AttenuatorShaping
      • BandwidthShaping
      • Shaping
      • SourceShaping
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.Properties
      • Resources
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.ResultProcessors
      • FResQResult
      • StabilityMarginResult
    • OmicronLab.VectorNetworkAnalysis.AutomationInterface.TaskProcessors
      • Averaging
    • OmicronLab.VectorNetworkAnalysis.MeasurementProcessors.Enumerations
      • FResQFormats

    Class Calibration

    Calibration class for BodeDevice AutomationInterface.

    Inheritance
    System.Object
    Calibration
    Implements
    GainCalibration
    ImpedanceCalibration
    MultiModeCalibration
    GainUserRange
    GainFullRange
    ImpedanceFullRange
    ImpedanceUserRange
    MultiModeFullRange
    MultiModeUserRange
    Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface
    Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll (3.50.2911.0)
    Syntax
    [Guid("5239F012-BF74-4FE9-AF14-71E3D7A2140B")]
    [ClassInterface(ClassInterfaceType.None)]
    [ComVisible(true)]
    public sealed class Calibration : VnaCalibrationManager, GainCalibration, ImpedanceCalibration, MultiModeCalibration, GainUserRange, GainFullRange, ImpedanceFullRange, ImpedanceUserRange, MultiModeFullRange, MultiModeUserRange

    Constructors

    Calibration(IMeasurementSuite<DeviceConfigurationBase, MeasurementTask>)

    Initializes a new instance of the Calibration class.

    Declaration
    public Calibration(IMeasurementSuite<DeviceConfigurationBase, MeasurementTask> suite)
    Parameters
    Type Name Description
    IMeasurementSuite<DeviceConfigurationBase, MeasurementTask> suite

    The measurement suite.

    Properties

    CalibrationValues

    Gets or sets the calibration values.

    Declaration
    public CorrectionValues CalibrationValues { get; set; }
    Property Value
    Type Description
    CorrectionValues

    FullRange

    Gets the full range calibration settings.

    Declaration
    public ImpedanceFullRange FullRange { get; }
    Property Value
    Type Description
    ImpedanceFullRange

    The full range calibration settings.

    GainFullRange

    Gets the full range calibration settings.

    Declaration
    public GainFullRange GainFullRange { get; }
    Property Value
    Type Description
    GainFullRange

    The full range calibration settings.

    GainUserRange

    Gets the user range calibration settings.

    Declaration
    public GainUserRange GainUserRange { get; }
    Property Value
    Type Description
    GainUserRange

    The user range calibration settings.

    ImpedanceFullRange

    Gets the full range calibration settings.

    Declaration
    public ImpedanceFullRange ImpedanceFullRange { get; }
    Property Value
    Type Description
    ImpedanceFullRange

    The full range calibration settings.

    ImpedanceUserRange

    Gets the user range calibration settings.

    Declaration
    public ImpedanceUserRange ImpedanceUserRange { get; }
    Property Value
    Type Description
    ImpedanceUserRange

    The user range calibration settings.

    IsCalibrationExtrapolated

    Gets a value indicating whether this calibration is extrapolated.

    Declaration
    public bool IsCalibrationExtrapolated { get; }
    Property Value
    Type Description
    System.Boolean

    Load

    Gets or sets the resistance value in Ω used for the load calibration.

    Declaration
    public double Load { get; set; }
    Property Value
    Type Description
    System.Double

    The load.

    Remarks

    In Ω.

    ShortDelayTime

    Gets or sets the short delay time.

    Declaration
    public double ShortDelayTime { get; set; }
    Property Value
    Type Description
    System.Double

    The short delay time.

    Remarks

    In picoseconds.

    UserRange

    Gets the user range calibration settings.

    Declaration
    public ImpedanceUserRange UserRange { get; }
    Property Value
    Type Description
    ImpedanceUserRange

    The user range calibration settings.

    Methods

    GetCalibrationActiveState(CalibrationMode)

    Gets the active state of the calibration depending on the calibration mode.

    Declaration
    public bool GetCalibrationActiveState(CalibrationMode calibrationMode)
    Parameters
    Type Name Description
    CalibrationMode calibrationMode

    The calibration mode.

    Returns
    Type Description
    System.Boolean

    GetCalibrationAvailableState(CalibrationMode)

    Gets the availability of the calibration depending on the calibration mode.

    Declaration
    public bool GetCalibrationAvailableState(CalibrationMode calibrationMode)
    Parameters
    Type Name Description
    CalibrationMode calibrationMode

    The calibration mode.

    Returns
    Type Description
    System.Boolean

    GetCalibrationEnableState(CalibrationMode)

    Gets the enabled state of the calibration depending on the calibration mode.

    Declaration
    public bool GetCalibrationEnableState(CalibrationMode calibrationMode)
    Parameters
    Type Name Description
    CalibrationMode calibrationMode

    The calibration mode.

    Returns
    Type Description
    System.Boolean

    GetMultiModeCalibrationType(CalibrationMode)

    Gets the calibration multi mode toggle between Thru or Open/Short/Load.

    Declaration
    public CalibrationMultiModeToggle GetMultiModeCalibrationType(CalibrationMode mode)
    Parameters
    Type Name Description
    CalibrationMode mode

    The mode.

    Returns
    Type Description
    CalibrationMultiModeToggle

    LoadCalibration(CalibrationMode, String, Action<(CalibrationLoadingState State, String PathInformation)>)

    Loads the calibration mode related calibration data from the user specified path.

    Declaration
    public bool LoadCalibration(CalibrationMode mode, string path, Action<(CalibrationLoadingState State, string PathInformation)> calibrationLoadingFailedHandler = null)
    Parameters
    Type Name Description
    CalibrationMode mode

    The calibration mode.

    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    System.Action<System.ValueTuple<CalibrationLoadingState, System.String>> calibrationLoadingFailedHandler

    The handler which will be used when an error occures during calibration file loading and the default error handling is not enough.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    LoadCalibration(String)

    Loads the calibration data from the user specified path.

    Declaration
    [Obsolete("Please use 'LoadCalibration' from 'UserRange' and 'FullRange'.Changed because this allows more flexible calibration loading!)")]
    public bool LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    LoadCalibrationFromStream(Stream)

    Loads the calibration as stream.

    Declaration
    public bool LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    LoadCalibrationFromStreamAsync(Stream)

    Loads the calibration as stream asynchronous.

    Declaration
    public async Task<bool> LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    PrepareCalibrations(IMeasurementSuite)

    Prepares the calibrations for the related suite to be in well defined state during calibration process.

    Declaration
    protected override void PrepareCalibrations(IMeasurementSuite suite)
    Parameters
    Type Name Description
    IMeasurementSuite suite

    The suite.

    SaveCalibration(String)

    Saves the calibration data to the user specified path.

    Declaration
    public bool SaveCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    SaveCalibrationAsStream(Stream)

    Saves the calibration as stream.

    Declaration
    public bool SaveCalibrationAsStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    SaveCalibrationAsStreamAsync(Stream)

    Saves the calibration as stream asynchronous.

    Declaration
    public async Task<bool> SaveCalibrationAsStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    SaveCalibrationAsync(String)

    Saves the calibration data to the specified path asynchronous.

    Declaration
    public Task<bool> SaveCalibrationAsync(string path)
    Parameters
    Type Name Description
    System.String path

    The file path.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    SetCalibrationEnableState(CalibrationMode, Boolean)

    Sets the enabled state of the related calibration mode.

    Declaration
    public void SetCalibrationEnableState(CalibrationMode calibrationMode, bool isEnabled)
    Parameters
    Type Name Description
    CalibrationMode calibrationMode

    The calibration mode.

    System.Boolean isEnabled

    if set to true the enabled state will be set; the disabled state otherwise.

    SetMultiModeCalibrationType(CalibrationMultiModeToggle, CalibrationMode)

    Sets the calibration multi mode toggle between Thru or Open/Short/Load.

    Declaration
    public CalibrationMultiModeToggle SetMultiModeCalibrationType(CalibrationMultiModeToggle type, CalibrationMode mode)
    Parameters
    Type Name Description
    CalibrationMultiModeToggle type

    The type.

    CalibrationMode mode

    The mode.

    Returns
    Type Description
    CalibrationMultiModeToggle
    Remarks

    Returns the actual set value. Will be changed in case of missing calibration.

    Stop()

    Stops the calibration if it is running.

    Declaration
    public override bool Stop()
    Returns
    Type Description
    System.Boolean

    true if the test was stopped successful or was not running at all; otherwise, false.

    Remarks

    Depending on the OmicronLab.BaseMidLayer.Enumerations.SourceMode the source will be switched accordingly.

    Events

    FullRangeIsActiveChanged

    Is active changed.

    Declaration
    public event FullRangeIsActiveChanged_Delegate FullRangeIsActiveChanged
    Event Type
    Type Description
    FullRangeIsActiveChanged_Delegate

    FullRangeIsAvailableChanged

    Is available changed.

    Declaration
    public event FullRangeIsAvailableChanged_Delegate FullRangeIsAvailableChanged
    Event Type
    Type Description
    FullRangeIsAvailableChanged_Delegate

    UserRangeIsActiveChanged

    Is active changed.

    Declaration
    public event UserRangeIsActiveChanged_Delegate UserRangeIsActiveChanged
    Event Type
    Type Description
    UserRangeIsActiveChanged_Delegate

    UserRangeIsAvailableChanged

    Is available changed.

    Declaration
    public event UserRangeIsAvailableChanged_Delegate UserRangeIsAvailableChanged
    Event Type
    Type Description
    UserRangeIsAvailableChanged_Delegate

    Explicit Interface Implementations

    GainCalibration.FullRange

    Gets the full range calibration settings.

    Declaration
    GainFullRange GainCalibration.FullRange { get; }
    Returns
    Type Description
    GainFullRange

    The full range calibration settings.

    GainCalibration.UserRange

    Gets the user range calibration settings.

    Declaration
    GainUserRange GainCalibration.UserRange { get; }
    Returns
    Type Description
    GainUserRange

    The user range calibration settings.

    GainFullRange.ExecuteThru()

    Executes the thru gain calibration.

    Declaration
    ExecutionState GainFullRange.ExecuteThru()
    Returns
    Type Description
    ExecutionState

    GainFullRange.ExecuteThruAsync()

    Executes the thru gain calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> GainFullRange.ExecuteThruAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    GainFullRange.IsActive

    Gets a value indicating whether this calibration is in use for the measurement.

    Declaration
    bool GainFullRange.IsActive { get; }
    Returns
    Type Description
    System.Boolean

    true if this is active; otherwise, false.

    GainFullRange.IsAvailable

    Gets a value indicating whether the calibration data is available.

    Declaration
    bool GainFullRange.IsAvailable { get; }
    Returns
    Type Description
    System.Boolean

    true if this is available; otherwise, false.

    GainFullRange.IsEnabled

    Gets or sets a value indicating whether this calibration is enabled by the user (only possible if available).

    Declaration
    bool GainFullRange.IsEnabled { get; set; }
    Returns
    Type Description
    System.Boolean

    true if this is enabled; otherwise, false.

    GainFullRange.LoadCalibration(String)

    Loads the full range related calibration data from the user specified path.

    Declaration
    bool GainFullRange.LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    GainFullRange.LoadCalibrationFromStream(Stream)

    Loads the full range related calibration as stream.

    Declaration
    bool GainFullRange.LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    GainFullRange.LoadCalibrationFromStreamAsync(Stream)

    Loads the full range related calibration as stream asynchronous.

    Declaration
    async Task<bool> GainFullRange.LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    GainFullRange.Values

    Gets the gain calibration values.

    Declaration
    GainFullCalibrationValues GainFullRange.Values { get; }
    Returns
    Type Description
    GainFullCalibrationValues

    The calibration values.

    GainUserRange.ExecuteThru()

    Executes the thru gain calibration.

    Declaration
    ExecutionState GainUserRange.ExecuteThru()
    Returns
    Type Description
    ExecutionState

    GainUserRange.ExecuteThruAsync()

    Executes the thru gain calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> GainUserRange.ExecuteThruAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    GainUserRange.IsActive

    Gets a value indicating whether this calibration is in use for the measurement.

    Declaration
    bool GainUserRange.IsActive { get; }
    Returns
    Type Description
    System.Boolean

    true if this is active; otherwise, false.

    GainUserRange.IsAvailable

    Gets a value indicating whether the calibration data is available.

    Declaration
    bool GainUserRange.IsAvailable { get; }
    Returns
    Type Description
    System.Boolean

    true if this is available; otherwise, false.

    GainUserRange.IsEnabled

    Gets or sets a value indicating whether this calibration is enabled by the user (only possible if available).

    Declaration
    bool GainUserRange.IsEnabled { get; set; }
    Returns
    Type Description
    System.Boolean

    true if this is enabled; otherwise, false.

    GainUserRange.LoadCalibration(String)

    Loads the user range related calibration data from the user specified path.

    Declaration
    bool GainUserRange.LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    GainUserRange.LoadCalibrationFromStream(Stream)

    Loads the user range related calibration as stream.

    Declaration
    bool GainUserRange.LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    GainUserRange.LoadCalibrationFromStreamAsync(Stream)

    Loads the user range related calibration as stream asynchronous.

    Declaration
    async Task<bool> GainUserRange.LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    GainUserRange.Values

    Gets the gain calibration values.

    Declaration
    GainUserCalibrationValues GainUserRange.Values { get; }
    Returns
    Type Description
    GainUserCalibrationValues

    The calibration values.

    ImpedanceFullRange.ExecuteLoad()

    Executes the load calibration.

    Declaration
    ExecutionState ImpedanceFullRange.ExecuteLoad()
    Returns
    Type Description
    ExecutionState

    ImpedanceFullRange.ExecuteLoadAsync()

    Executes the load calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> ImpedanceFullRange.ExecuteLoadAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    ImpedanceFullRange.ExecuteOpen()

    Executes the open calibration.

    Declaration
    ExecutionState ImpedanceFullRange.ExecuteOpen()
    Returns
    Type Description
    ExecutionState

    ImpedanceFullRange.ExecuteOpenAsync()

    Executes the open calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> ImpedanceFullRange.ExecuteOpenAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    ImpedanceFullRange.ExecuteShort()

    Executes the short calibration.

    Declaration
    ExecutionState ImpedanceFullRange.ExecuteShort()
    Returns
    Type Description
    ExecutionState

    ImpedanceFullRange.ExecuteShortAsync()

    Executes the short calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> ImpedanceFullRange.ExecuteShortAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    ImpedanceFullRange.IsActive

    Gets a value indicating whether this calibration is in use for the measurement.

    Declaration
    bool ImpedanceFullRange.IsActive { get; }
    Returns
    Type Description
    System.Boolean

    true if this is active; otherwise, false.

    ImpedanceFullRange.IsAvailable

    Gets a value indicating whether the calibration data is available.

    Declaration
    bool ImpedanceFullRange.IsAvailable { get; }
    Returns
    Type Description
    System.Boolean

    true if this is available; otherwise, false.

    ImpedanceFullRange.IsEnabled

    Gets or sets a value indicating whether this calibration is enabled by the user (only possible if available).

    Declaration
    bool ImpedanceFullRange.IsEnabled { get; set; }
    Returns
    Type Description
    System.Boolean

    true if this is enabled; otherwise, false.

    ImpedanceFullRange.LoadCalibration(String)

    Loads the full range related calibration data from the user specified path.

    Declaration
    bool ImpedanceFullRange.LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    ImpedanceFullRange.LoadCalibrationFromStream(Stream)

    Loads the full range related calibration as stream.

    Declaration
    bool ImpedanceFullRange.LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    ImpedanceFullRange.LoadCalibrationFromStreamAsync(Stream)

    Loads the full range related calibration as stream asynchronous.

    Declaration
    async Task<bool> ImpedanceFullRange.LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    ImpedanceFullRange.Values

    Gets the impedance calibration values.

    Declaration
    ImpedanceFullCalibrationValues ImpedanceFullRange.Values { get; }
    Returns
    Type Description
    ImpedanceFullCalibrationValues

    The calibration values.

    ImpedanceUserRange.ExecuteLoad()

    Executes the load calibration.

    Declaration
    ExecutionState ImpedanceUserRange.ExecuteLoad()
    Returns
    Type Description
    ExecutionState

    ImpedanceUserRange.ExecuteLoadAsync()

    Executes the load calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> ImpedanceUserRange.ExecuteLoadAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    ImpedanceUserRange.ExecuteOpen()

    Executes the open calibration.

    Declaration
    ExecutionState ImpedanceUserRange.ExecuteOpen()
    Returns
    Type Description
    ExecutionState

    ImpedanceUserRange.ExecuteOpenAsync()

    Executes the open calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> ImpedanceUserRange.ExecuteOpenAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    ImpedanceUserRange.ExecuteShort()

    Executes the short calibration.

    Declaration
    ExecutionState ImpedanceUserRange.ExecuteShort()
    Returns
    Type Description
    ExecutionState

    ImpedanceUserRange.ExecuteShortAsync()

    Executes the short calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> ImpedanceUserRange.ExecuteShortAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    ImpedanceUserRange.IsActive

    Gets a value indicating whether this calibration is in use for the measurement.

    Declaration
    bool ImpedanceUserRange.IsActive { get; }
    Returns
    Type Description
    System.Boolean

    true if this is active; otherwise, false.

    ImpedanceUserRange.IsAvailable

    Gets a value indicating whether the calibration data is available.

    Declaration
    bool ImpedanceUserRange.IsAvailable { get; }
    Returns
    Type Description
    System.Boolean

    true if this is available; otherwise, false.

    ImpedanceUserRange.IsEnabled

    Gets or sets a value indicating whether this calibration is enabled by the user (only possible if available).

    Declaration
    bool ImpedanceUserRange.IsEnabled { get; set; }
    Returns
    Type Description
    System.Boolean

    true if this is enabled; otherwise, false.

    ImpedanceUserRange.LoadCalibration(String)

    Loads the user range related calibration data from the user specified path.

    Declaration
    bool ImpedanceUserRange.LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    ImpedanceUserRange.LoadCalibrationFromStream(Stream)

    Loads the user range related calibration as stream.

    Declaration
    bool ImpedanceUserRange.LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    ImpedanceUserRange.LoadCalibrationFromStreamAsync(Stream)

    Loads the user range related calibration as stream asynchronous.

    Declaration
    async Task<bool> ImpedanceUserRange.LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    ImpedanceUserRange.Values

    Gets the gain calibration values.

    Declaration
    ImpedanceUserCalibrationValues ImpedanceUserRange.Values { get; }
    Returns
    Type Description
    ImpedanceUserCalibrationValues

    The calibration values.

    MultiModeCalibration.FullRange

    Gets the full range calibration settings.

    Declaration
    MultiModeFullRange MultiModeCalibration.FullRange { get; }
    Returns
    Type Description
    MultiModeFullRange

    The full range calibration settings.

    MultiModeCalibration.UserRange

    Gets the user range calibration settings.

    Declaration
    MultiModeUserRange MultiModeCalibration.UserRange { get; }
    Returns
    Type Description
    MultiModeUserRange

    The user range calibration settings.

    MultiModeFullRange.ExecuteLoad()

    Executes the load calibration.

    Declaration
    ExecutionState MultiModeFullRange.ExecuteLoad()
    Returns
    Type Description
    ExecutionState

    MultiModeFullRange.ExecuteLoadAsync()

    Executes the load calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeFullRange.ExecuteLoadAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeFullRange.ExecuteOpen()

    Executes the open calibration.

    Declaration
    ExecutionState MultiModeFullRange.ExecuteOpen()
    Returns
    Type Description
    ExecutionState

    MultiModeFullRange.ExecuteOpenAsync()

    Executes the open calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeFullRange.ExecuteOpenAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeFullRange.ExecuteShort()

    Executes the short calibration.

    Declaration
    ExecutionState MultiModeFullRange.ExecuteShort()
    Returns
    Type Description
    ExecutionState

    MultiModeFullRange.ExecuteShortAsync()

    Executes the short calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeFullRange.ExecuteShortAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeFullRange.ExecuteThru()

    Executes the thru gain calibration.

    Declaration
    ExecutionState MultiModeFullRange.ExecuteThru()
    Returns
    Type Description
    ExecutionState

    MultiModeFullRange.ExecuteThruAsync()

    Executes the thru gain calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeFullRange.ExecuteThruAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeFullRange.GetCalibrationType()

    Gets the calibration multi mode toggle type.

    Declaration
    CalibrationMultiModeToggle MultiModeFullRange.GetCalibrationType()
    Returns
    Type Description
    CalibrationMultiModeToggle

    MultiModeFullRange.IsActive

    Gets a value indicating whether this calibration is in use for the measurement.

    Declaration
    bool MultiModeFullRange.IsActive { get; }
    Returns
    Type Description
    System.Boolean

    true if this is active; otherwise, false.

    MultiModeFullRange.IsAvailable

    Gets a value indicating whether the calibration data is available.

    Declaration
    bool MultiModeFullRange.IsAvailable { get; }
    Returns
    Type Description
    System.Boolean

    true if this is available; otherwise, false.

    MultiModeFullRange.IsEnabled

    Gets or sets a value indicating whether this calibration is enabled by the user (only possible if available).

    Declaration
    bool MultiModeFullRange.IsEnabled { get; set; }
    Returns
    Type Description
    System.Boolean

    true if this is enabled; otherwise, false.

    MultiModeFullRange.LoadCalibration(String)

    Loads the full range related calibration data from the user specified path.

    Declaration
    bool MultiModeFullRange.LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    MultiModeFullRange.LoadCalibrationFromStream(Stream)

    Loads the full range related calibration as stream.

    Declaration
    bool MultiModeFullRange.LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    MultiModeFullRange.LoadCalibrationFromStreamAsync(Stream)

    Loads the full range related calibration as stream asynchronous.

    Declaration
    async Task<bool> MultiModeFullRange.LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    MultiModeFullRange.SetCalibrationType(CalibrationMultiModeToggle)

    Sets the calibration multi mode toggle between Thru or Open/Short/Load.

    Declaration
    CalibrationMultiModeToggle MultiModeFullRange.SetCalibrationType(CalibrationMultiModeToggle type)
    Parameters
    Type Name Description
    CalibrationMultiModeToggle type

    type.

    Returns
    Type Description
    CalibrationMultiModeToggle

    The calibration multi mode toggle.

    Remarks

    Returns the actual set value. Will be changed ion case of missing calibration.

    MultiModeFullRange.Values

    Gets the impedance calibration values.

    Declaration
    MultiModeFullCalibrationValues MultiModeFullRange.Values { get; }
    Returns
    Type Description
    MultiModeFullCalibrationValues

    The calibration values.

    MultiModeUserRange.ExecuteLoad()

    Executes the load calibration.

    Declaration
    ExecutionState MultiModeUserRange.ExecuteLoad()
    Returns
    Type Description
    ExecutionState

    MultiModeUserRange.ExecuteLoadAsync()

    Executes the load calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeUserRange.ExecuteLoadAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeUserRange.ExecuteOpen()

    Executes the open calibration.

    Declaration
    ExecutionState MultiModeUserRange.ExecuteOpen()
    Returns
    Type Description
    ExecutionState

    MultiModeUserRange.ExecuteOpenAsync()

    Executes the open calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeUserRange.ExecuteOpenAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeUserRange.ExecuteShort()

    Executes the short calibration.

    Declaration
    ExecutionState MultiModeUserRange.ExecuteShort()
    Returns
    Type Description
    ExecutionState

    MultiModeUserRange.ExecuteShortAsync()

    Executes the short calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeUserRange.ExecuteShortAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeUserRange.ExecuteThru()

    Executes the thru gain calibration.

    Declaration
    ExecutionState MultiModeUserRange.ExecuteThru()
    Returns
    Type Description
    ExecutionState

    MultiModeUserRange.ExecuteThruAsync()

    Executes the thru gain calibration asynchronous.

    Declaration
    [Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
    Task<ExecutionState> MultiModeUserRange.ExecuteThruAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<ExecutionState>

    MultiModeUserRange.GetCalibrationType()

    Gets the calibration multi mode toggle type.

    Declaration
    CalibrationMultiModeToggle MultiModeUserRange.GetCalibrationType()
    Returns
    Type Description
    CalibrationMultiModeToggle

    MultiModeUserRange.IsActive

    Gets a value indicating whether this calibration is in use for the measurement.

    Declaration
    bool MultiModeUserRange.IsActive { get; }
    Returns
    Type Description
    System.Boolean

    true if this is active; otherwise, false.

    MultiModeUserRange.IsAvailable

    Gets a value indicating whether the calibration data is available.

    Declaration
    bool MultiModeUserRange.IsAvailable { get; }
    Returns
    Type Description
    System.Boolean

    true if this is available; otherwise, false.

    MultiModeUserRange.IsEnabled

    Gets or sets a value indicating whether this calibration is enabled by the user (only possible if available).

    Declaration
    bool MultiModeUserRange.IsEnabled { get; set; }
    Returns
    Type Description
    System.Boolean

    true if this is enabled; otherwise, false.

    MultiModeUserRange.LoadCalibration(String)

    Loads the user range related calibration data from the user specified path.

    Declaration
    bool MultiModeUserRange.LoadCalibration(string path)
    Parameters
    Type Name Description
    System.String path

    The user specified file path. The file extension '.mcalx' is required.

    Returns
    Type Description
    System.Boolean
    Remarks

    The path parameter can specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory.

    MultiModeUserRange.LoadCalibrationFromStream(Stream)

    Loads the user range related calibration as stream.

    Declaration
    bool MultiModeUserRange.LoadCalibrationFromStream(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Boolean

    MultiModeUserRange.LoadCalibrationFromStreamAsync(Stream)

    Loads the user range related calibration as stream asynchronous.

    Declaration
    async Task<bool> MultiModeUserRange.LoadCalibrationFromStreamAsync(Stream stream)
    Parameters
    Type Name Description
    Stream stream

    The stream.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    MultiModeUserRange.SetCalibrationType(CalibrationMultiModeToggle)

    Sets the calibration multi mode toggle between Thru or Open/Short/Load.

    Declaration
    CalibrationMultiModeToggle MultiModeUserRange.SetCalibrationType(CalibrationMultiModeToggle type)
    Parameters
    Type Name Description
    CalibrationMultiModeToggle type

    type.

    Returns
    Type Description
    CalibrationMultiModeToggle

    The calibration multi mode toggle.

    Remarks

    Returns the actual set value. Will be changed ion case of missing calibration.

    MultiModeUserRange.Values

    Gets the impedance calibration values.

    Declaration
    MultiModeUserCalibrationValues MultiModeUserRange.Values { get; }
    Returns
    Type Description
    MultiModeUserCalibrationValues

    The calibration values.

    Implements

    GainCalibration
    ImpedanceCalibration
    MultiModeCalibration
    GainUserRange
    GainFullRange
    ImpedanceFullRange
    ImpedanceUserRange
    MultiModeFullRange
    MultiModeUserRange
    Back to top Generated by DocFX