Interface GainMeasurement

Gain Measurement settings.

Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces.Measurements

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

Syntax

[Guid("5863F737-01EB-4FD5-A8D6-C3D3374957F4")]
[InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
[ComVisible(true)]
public interface GainMeasurement : IDisposable

Remarks

Measure Gain/Phase (transfer function H(f)) using the external reference.

Properties

Attenuation

Gets the Attenuation of Channel 1 and Channel 2.

Declaration

Attenuation Attenuation { get; }

Property Value

Type	Description
Attenuation	The Attenuation in dB.

Remarks

Factory default values can be seen in the Automation reference documentation --> Measurement Modes.

Averaging

Gets the averaging.

Declaration

Averaging Averaging { get; }

Property Value

Type	Description
Averaging

Calibration

Gets the calibration.

Declaration

GainCalibration Calibration { get; }

Property Value

Type	Description
GainCalibration	The calibration.

DutSettlingTime

Gets or sets the device under test settling time.

Declaration

double DutSettlingTime { get; set; }

Property Value

Type	Description
System.Double	The time in milliseconds.

Remarks

Note: DUT settling time is added to each frequency point of a sweep. DUT settling time is the time between starting the output signal and starting to take samples for the measurement.
Factory default values can be seen in the Automation reference documentation --> Measurement Modes.

ExternalProbeChannel1

Gets or sets the external probe Channel 1.

Declaration

double ExternalProbeChannel1 { get; set; }

Property Value

Type	Description
System.Double	The external probe Channel 1.

Remarks

Factory default values can be seen in the Automation reference documentation --> Measurement Modes.

ExternalProbeChannel2

Gets or sets the external probe Channel 2.

Declaration

double ExternalProbeChannel2 { get; set; }

Property Value

Type	Description
System.Double	The external probe Channel 2.

Remarks

Factory default values can be seen in the Automation reference documentation --> Measurement Modes.

MeasurementFrequencies

Gets the measurement points.

Declaration

double[] MeasurementFrequencies { get; }

Property Value

Type	Description
System.Double[]	The measurement points.

Remarks

Returns list of measurement points.

NumberOfPoints

Gets the number of frequency points.

Declaration

int NumberOfPoints { get; }

Property Value

Type	Description
System.Int32	The number of frequency points.

Remarks

Returns 1 for single mode.

ReceiverBandwidth

Gets or sets the receiver bandwidth.

Declaration

ReceiverBandwidth ReceiverBandwidth { get; set; }

Property Value

Type	Description
ReceiverBandwidth

Remarks

The predefined enumerations uses values in Hz.

Results

Gets the gain measurement results.

Declaration

GainResults Results { get; }

Property Value

Type	Description
GainResults	The gain measurement results.

Shaping

Gets the source shaping.

Declaration

Shaping Shaping { get; }

Property Value

Type	Description
Shaping

StartFrequency

Gets the start frequency.

Declaration

double StartFrequency { get; }

Property Value

Type	Description
System.Double	The start frequency.

Remarks

Returns frequency value for single mode.

StopFrequency

Gets the stop frequency.

Declaration

double StopFrequency { get; }

Property Value

Type	Description
System.Double	The stop frequency.

Remarks

Returns frequency value for single mode.

SweepMode

Gets the sweep mode.

Declaration

SweepMode SweepMode { get; }

Property Value

Type	Description
SweepMode	The sweep mode.

TerminationChannel1

Gets or sets the termination for Channel 1.

Declaration

Termination TerminationChannel1 { get; set; }

Property Value

Type	Description
Termination	The termination resistor Channel 1.

Remarks

Factory default values can be seen in the Automation reference documentation --> Measurement Modes.

TerminationChannel2

Gets or sets the termination for Channel 2.

Declaration

Termination TerminationChannel2 { get; set; }

Property Value

Type	Description
Termination	The termination Channel 2.

Remarks

Factory default values can be seen in the Automation reference documentation --> Measurement Modes.

Methods

CalculateMeasurementTime()

Calculates the measurement time the HW will need to execute the current sweep.

Declaration

double CalculateMeasurementTime()

Returns

Type	Description
System.Double	The time in seconds.

Remarks

This calculation does include the actual measurement time, the DUT delay and detector measurements, but NOT e.g. switching time for e.g. shaped attenuators.

ConfigureCustomSweep(ref Double[])

Configures the custom sweep.

Declaration

void ConfigureCustomSweep(ref double[] frequencies)

Parameters

Type	Name	Description
System.Double[]	frequencies	The frequencies.

ConfigureSinglePoint(Double)

Configures the single point measurement.

Declaration

void ConfigureSinglePoint(double frequency)

Parameters

Type	Name	Description
System.Double	frequency	The frequency.

ConfigureSweep(Double, Double, Int32, SweepMode)

Configures the sweep./>.

Declaration

void ConfigureSweep(double startFrequency, double stopFrequency, int numberOfPoints, SweepMode sweepMode)

Parameters

Type	Name	Description
System.Double	startFrequency	The start frequency.
System.Double	stopFrequency	The stop frequency.
System.Int32	numberOfPoints	The number of frequency points.
SweepMode	sweepMode	The sweep mode.

Remarks

NumberOfPoints == 1 is allowed and behaves like ConfigureSinglePoint(Double). StartFrequency == stopFrequency is NOT allowed and leads to an exception.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

void Dispose()

ExecuteMeasurement()

Executes the test with the specified mode synchronous.

Declaration

ExecutionState ExecuteMeasurement()

Returns

Type	Description
ExecutionState	ExecutionStatus object with information about the measurement.

Remarks

Do NOT start more than one measurement per measurement object in parallel. Execution must be finished before starting a new one.

ExecuteMeasurementAsync()

Executes the test with the specified mode asynchronous.

Declaration

[ComVisible(false)]
[Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
Task<ExecutionState> ExecuteMeasurementAsync()

Returns

Type	Description
System.Threading.Tasks.Task<ExecutionState>	ExecutionStatus object with information about the measurement.

Remarks

Do NOT start more than one measurement per measurement object in parallel. Execution must be finished before starting a new one.

GetSourceLevel(LevelUnit)

Gets the source level.

Declaration

double GetSourceLevel(LevelUnit unit)

Parameters

Type	Name	Description
LevelUnit	unit	The source level unit.

Returns

Type	Description
System.Double	Returns the source level value, depending on the unit.

SetSourceLevel(Double, LevelUnit)

Sets the source level.

Declaration

void SetSourceLevel(double level, LevelUnit unit)

Parameters

Type	Name	Description
System.Double	level	The source level value.
LevelUnit	unit	The source level unit.

StopCurrentExecution()

Stops the current execution.

Declaration

void StopCurrentExecution()

StopCurrentExecutionAsync()

Stops the current execution asynchronous.

Declaration

[ComVisible(false)]
[Obsolete("Please use the non-async method. Async support was removed because of problems with the device driver.", true)]
Task StopCurrentExecutionAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Events

NewResultAvailable

Occurs when a new measurement result is available.

Declaration

event NewResultAvailableDelegate NewResultAvailable

Event Type

Type	Description
NewResultAvailableDelegate

Remarks

NOT supported in Delphi and MatLab. Alternatively one can wait for the completion of the execution.