NI-RFPM API Reference

Table of Contents

RfpmMeasurements.FetchReceiverMeasurements Method (DoubleMeasurementFormat, String, ReceiverType, String, TimeSpan, RfpmSingleMeasurementResult(Double))

  • Updated2023-12-28
  • 2 minute(s) read
RfpmMeasurements.FetchReceiverMeasurements Method (DoubleMeasurementFormat, String, ReceiverType, String, TimeSpan, RfpmSingleMeasurementResult(Double))

RfpmMeasurementsFetchReceiverMeasurements Method (DoubleMeasurementFormat, String, ReceiverType, String, TimeSpan, RfpmSingleMeasurementResultDouble)

Fetches the formatted receiver measurement results and returns a RfpmMultipleMeasurementResultT object containing the last completed measurement in double precision floating point, frequencies, and port powers.

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

Syntax

public RfpmSingleMeasurementResult<double> FetchReceiverMeasurements(
	DoubleMeasurementFormat format,
	string receiverPort,
	ReceiverType receiverType,
	string drivingPort,
	TimeSpan maxTime,
	ref RfpmSingleMeasurementResult<double> fetchResult
)
Public Function FetchReceiverMeasurements ( 
	format As DoubleMeasurementFormat,
	receiverPort As String,
	receiverType As ReceiverType,
	drivingPort As String,
	maxTime As TimeSpan,
	ByRef fetchResult As RfpmSingleMeasurementResult(Of Double)
) As RfpmSingleMeasurementResult(Of Double)

Parameters

format
Type: NationalInstruments.ModularInstruments.NIRfpmDoubleMeasurementFormat
The format that should be applied to the measurement data.
receiverPort
Type: SystemString
The receiver to fetch from.
receiverType
Type: NationalInstruments.ModularInstruments.NIRfpmReceiverType
The type of the receiver.
drivingPort
Type: SystemString
The port where the stimulus was applied during the desired measurement.
maxTime
Type: SystemTimeSpan
The amount of time to wait before throwing an exception, if the measurement is not complete.
fetchResult
Type: NationalInstruments.ModularInstruments.NIRfpmRfpmSingleMeasurementResultDouble
A RfpmMultipleMeasurementResultT object to contain the results of the fetch operation.

Return Value

Type: RfpmSingleMeasurementResultDouble
A RfpmMultipleMeasurementResultT object containing the results of the fetch operation.

Exceptions

ExceptionCondition
ObjectDisposedExceptionFetchReceiverMeasurements(DoubleMeasurementFormat, String, ReceiverType, String, TimeSpan, RfpmSingleMeasurementResultDouble) was called after the associated NIRfpm or RfpmDriverUtility object was disposed.
ArgumentException The value for format is unknown.

-or-

The value for maxTime is invalid.
ArgumentNullException The value for receiverPort is .

-or-

The value for drivingPort is .
SelectorNameException The value for receiverPort is invalid.

-or-

The value for receiverPort is unknown.

-or-

The value for drivingPort is invalid.

-or-

The value for drivingPort is unknown.
InvalidOperationException The measurement was fetched while in the configuration state.
IviCDriverException The underlying NI-RFPM driver returned an error.

Remarks

You must call Initiate(String, String) first and then call WaitUntilDone(TimeSpan) before performing fetch operations.

When the fetchResult reference parameter is passed as , this method will internally allocate memory in a managed layer to the fetchResult data and is returned with the fetched data. If the fetchResult data reference parameter is not , then fetchResult will be used to store the fetched data. As a result, you should first make the call with fetchResult reference parameter set to , then use fetchResult to return data in subsequent calls to optimize memory usage.

See Also

Log in to get a better experience