Interface GainUserRange

Gain user range calibration settings.

Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Calibration

Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll (3.50.2911.0)

Syntax

[Guid("C975914E-8531-4397-9B3F-5374034DB209")]
[InterfaceType(ComInterfaceType.InterfaceIsDual)]
[ComVisible(true)]
public interface GainUserRange

Properties

IsActive

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

Declaration

bool IsActive { get; }

Property Value

Type	Description
System.Boolean	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
System.Boolean	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
System.Boolean	true if this is enabled; otherwise, false.

Values

Gets the gain calibration values.

Declaration

GainUserCalibrationValues Values { get; }

Property Value

Type	Description
GainUserCalibrationValues	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
System.Threading.Tasks.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
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.

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
System.String	path	The user specified file path.

Returns

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

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
System.Boolean

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
System.Threading.Tasks.Task<System.Boolean>

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