Interface GainFullRange

Gain full range calibration settings.

Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Calibration

Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll

Syntax

[Guid("D077EAB0-63AA-4D86-9D74-03EE69E2042F")]
[InterfaceType(ComInterfaceType.InterfaceIsDual)]
[ComVisible(true)]
public interface GainFullRange

Remarks

For further information about the supported frequency range please check the DeviceProperties of the BodeDevice or read the corresponding specifications section in the user manual.

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.

IsCalibrationExtrapolated

Gets a value indicating whether this calibration is extrapolated.

Declaration

bool IsCalibrationExtrapolated { get; }

Property Value

Type	Description
bool

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 gain calibration values.

Declaration

GainFullCalibrationValues Values { get; }

Property Value

Type	Description
GainFullCalibrationValues	The calibration values.

Methods

ExecuteThru()

Executes the thru gain calibration.

Declaration

ExecutionState ExecuteThru()

Returns

Type	Description
ExecutionState

ExecuteThruAsync()

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 thru gain 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> ExecuteThruAsync()

Returns

Type	Description
Task<ExecutionState>

LoadCalibration(string)

Loads the full 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 full 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 full 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 full 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

FullRangeIsActiveChanged

Is active changed.

Declaration

event FullRangeIsActiveChanged_Delegate FullRangeIsActiveChanged

Event Type

Type	Description
FullRangeIsActiveChanged_Delegate

FullRangeIsAvailableChanged

Is available changed.

Declaration

event FullRangeIsAvailableChanged_Delegate FullRangeIsAvailableChanged

Event Type

Type	Description
FullRangeIsAvailableChanged_Delegate