RfpmUtilityForSwitchReceiver.GetSettlingTime Method (String, ReceiverPath, ReceiverCouplingPath, Double, Double)

Download PDF

Updated2023-12-28
2 minute(s) read

RfpmUtilityForSwitchReceiverGetSettlingTime Method (String, ReceiverPath, ReceiverCouplingPath, 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(
	string port,
	ReceiverPath receiverPath,
	ReceiverCouplingPath receiverCouplingPath,
	double frequency,
	double referenceLevel
)

Public Function GetSettlingTime ( 
	port As String,
	receiverPath As ReceiverPath,
	receiverCouplingPath As ReceiverCouplingPath,
	frequency As Double,
	referenceLevel As Double
) As PrecisionTimeSpan

Parameters

port: Type: SystemString
The port in the receiver (RX) path to get the setting time for.
receiverPath: Type: NationalInstruments.ModularInstruments.NIRfpmReceiverPath
The receiver path used to connect the specified port.
receiverCouplingPath: Type: NationalInstruments.ModularInstruments.NIRfpmReceiverCouplingPath
The receiver coupling path used to connect the specified port.
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 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 NI-RPFM Switch receiver path.

Exceptions

Exception	Condition
ObjectDisposedException	GetSettlingTime(String, ReceiverPath, ReceiverCouplingPath, Double, Double) was called after the associated NIRfpm or RfpmDriverUtility object was disposed.
ArgumentNullException	The value for port is .
ArgumentException	The value for receiverPath is invalid. - or - The value for frequency is invalid. - or - The value for referenceLevel is invalid.
SelectorNameException	The value for port is invalid. - or - The value for port is unknown
FileFormatException	The value for frequency is not found in loaded sweep settings.
IviCDriverException	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 (String, ReceiverPath, ReceiverCouplingPath, Double, Double)

Syntax

Parameters

Return Value

Exceptions

Remarks

See Also

Reference

Log in to get a better experience