Interface ImpedanceUserRange

Full range impedance calibration.

Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Calibration

Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll

Syntax

[Guid("5C0E47F4-4EF7-40DE-A5FA-E02BB62AC468")]
[InterfaceType(ComInterfaceType.InterfaceIsDual)]
[ComVisible(true)]
public interface ImpedanceUserRange

Properties

IsActive

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

Declaration

bool IsActive { get; }

Property Value

Type	Description
bool	true if this is active; otherwise, false.

IsAvailable

Gets a value indicating whether the calibration data is available.

Declaration

bool IsAvailable { get; }

Property Value

Type	Description
bool	true if this is available; otherwise, false.

IsEnabled

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

Declaration

bool IsEnabled { get; set; }

Property Value

Type	Description
bool	true if this is enabled; otherwise, false.

Values

Gets the impedance calibration values.

Declaration

ImpedanceUserCalibrationValues Values { get; }

Property Value

Type	Description
ImpedanceUserCalibrationValues	The calibration values.

Methods

ExecuteLoad()

Executes the load calibration.

Declaration

ExecutionState ExecuteLoad()

Returns

Type	Description
ExecutionState

ExecuteLoadAsync()

Obsolete: Please use the non-async method. Async support was removed because of problems with the device driver. Method will be removed in one of our next versions!

Executes the load calibration asynchronous.

Declaration

[ComVisible(false)]
[Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver. Method will be removed in one of our next versions!", true)]
Task<ExecutionState> ExecuteLoadAsync()

Returns

Type	Description
Task<ExecutionState>

ExecuteOpen()

Executes the open calibration.

Declaration

ExecutionState ExecuteOpen()

Returns

Type	Description
ExecutionState

ExecuteOpenAsync()

Obsolete: Please use the non-async method. Async support was removed because of problems with the device driver. Method will be removed in one of our next versions!

Executes the open calibration asynchronous.

Declaration

[ComVisible(false)]
[Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver. Method will be removed in one of our next versions!", true)]
Task<ExecutionState> ExecuteOpenAsync()

Returns

Type	Description
Task<ExecutionState>

ExecuteShort()

Executes the short calibration.

Declaration

ExecutionState ExecuteShort()

Returns

Type	Description
ExecutionState

ExecuteShortAsync()

Obsolete: Please use the non-async method. Async support was removed because of problems with the device driver. Method will be removed in one of our next versions!

Executes the short calibration asynchronous.

Declaration

[ComVisible(false)]
[Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver. Method will be removed in one of our next versions!", true)]
Task<ExecutionState> ExecuteShortAsync()

Returns

Type	Description
Task<ExecutionState>

LoadCalibration(string)

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

Declaration

bool LoadCalibration(string path)

Parameters

Type	Name	Description
string	path	The user specified file path. The file extension '.mcalx' is required.

Returns

Type	Description
bool

Remarks

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

LoadCalibrationAsync(string)

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

Declaration

[ComVisible(false)]
Task<bool> LoadCalibrationAsync(string path)

Parameters

Type	Name	Description
string	path	The user specified file path.

Returns

Type	Description
Task<bool>

LoadCalibrationFromStream(Stream)

Loads the user range related calibration as IO stream.

Declaration

bool LoadCalibrationFromStream(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The IO stream.

Returns

Type	Description
bool

LoadCalibrationFromStreamAsync(Stream)

Loads the user range related calibration as IO stream asynchronous.

Declaration

[ComVisible(false)]
Task<bool> LoadCalibrationFromStreamAsync(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The IO stream.

Returns

Type	Description
Task<bool>

Events

UserRangeIsActiveChanged

Is active changed.

Declaration

event UserRangeIsActiveChanged_Delegate UserRangeIsActiveChanged

Event Type

Type	Description
UserRangeIsActiveChanged_Delegate

UserRangeIsAvailableChanged

Is available changed.

Declaration

event UserRangeIsAvailableChanged_Delegate UserRangeIsAvailableChanged

Event Type

Type	Description
UserRangeIsAvailableChanged_Delegate