RfpmUtilityForSwitchReceiver.GetSettlingTime Method (RfpmSwitchPathDescription, Double, Double)

Download PDF

Updated2023-12-28
2 minute(s) read

RfpmUtilityForSwitchReceiverGetSettlingTime Method (RfpmSwitchPathDescription, Double, Double)

Gets the time the user must wait for the signal at the NI-RFPM Switch receiver output channel to settle within the receiver amplitude settling accuracy specified by the ReceiverAmplitudeSettlingAccuracy.
This method does not support the mmWave subsystem.

Namespace: NationalInstruments.ModularInstruments.NIRfpm
Assembly: NationalInstruments.ModularInstruments.NIRfpm.Fx40 (in NationalInstruments.ModularInstruments.NIRfpm.Fx40.dll) Version: 2023

Syntax

public PrecisionTimeSpan GetSettlingTime(
	RfpmSwitchPathDescription pathDescription,
	double frequency,
	double referenceLevel
)

Public Function GetSettlingTime ( 
	pathDescription As RfpmSwitchPathDescription,
	frequency As Double,
	referenceLevel As Double
) As PrecisionTimeSpan

Parameters

pathDescription: Type: NationalInstruments.ModularInstruments.NIRfpmSwitchRfpmSwitchPathDescription
The switch path to get settling time for.
frequency: Type: SystemDouble
The frequency of the signal present at the NI-RFPM Switch receiver input channel, in hertz (Hz).
referenceLevel: Type: SystemDouble
The reference level of the signal present at the NI-RFPM Switch receiver input channel, in dBm.

Return Value

Type: PrecisionTimeSpan
The time required for the signal at the specified NI-RFPM Switch receiver path output channel to settle within the specified receiver amplitude settling accuracy specified by the ReceiverAmplitudeSettlingAccuracy after setting the specified RPFM switch receiver path.

Exceptions

Exception	Condition
ObjectDisposedException	GetSettlingTime(RfpmSwitchPathDescription, Double, Double) was called after the associated NIRfpm or RfpmDriverUtility object was disposed.
ArgumentException	The value for frequency is invalid. - or - The value for referenceLevel is invalid.
ArgumentNullException	The value for pathDescription is .
SelectorNameException	The value for one or more channel(s) in pathDescription is invalid. - or - The value for one or more channel(s) in pathDescription is unknown.
IviCDriverException	The value for IsPowerCorrectionEnabled is set to . - or - The underlying NI-RFPM driver returned an error.

Remarks

The settling time is dependent on the path between the two channels as well as the frequency and the reference level of the signal present at the NI-RFPM switch receiver input channel. When NI-RFPM de-embedding is enabled, the reference level is defined at the DUT reference plane.

NI-RFPM API Reference

Table of Contents

RfpmUtilityForSwitchReceiver.GetSettlingTime Method (RfpmSwitchPathDescription, Double, Double)

Syntax

Parameters

Return Value

Exceptions

Remarks

See Also

Reference

Log in to get a better experience