NI-RFPM API Reference

Table of Contents

RfpmMeasurements.FetchSingleSParameter Method (String, String, TimeSpan, RfpmSingleMeasurementResult(ComplexDouble))

  • Updated2023-12-28
  • 2 minute(s) read
RfpmMeasurements.FetchSingleSParameter Method (String, String, TimeSpan, RfpmSingleMeasurementResult(ComplexDouble))

RfpmMeasurementsFetchSingleSParameter Method (String, String, TimeSpan, RfpmSingleMeasurementResultComplexDouble)

Fetches the formatted S-parameter measurement results and returns a RfpmMultipleMeasurementResultT object containing an array of complex double values, frequencies, and port powers.

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

Syntax

public RfpmSingleMeasurementResult<ComplexDouble> FetchSingleSParameter(
	string stimulusPort,
	string responsePort,
	TimeSpan maxTime,
	ref RfpmSingleMeasurementResult<ComplexDouble> fetchResult
)
Public Function FetchSingleSParameter ( 
	stimulusPort As String,
	responsePort As String,
	maxTime As TimeSpan,
	ByRef fetchResult As RfpmSingleMeasurementResult(Of ComplexDouble)
) As RfpmSingleMeasurementResult(Of ComplexDouble)

Parameters

stimulusPort
Type: SystemString
Selecting the S-parameter to return, this is the port that applies the stimulus (the second number of the S-parameter). This uses absolute port numbers.
responsePort
Type: SystemString
Selecting the S-parameter to return, this is the port that is queried (the first number of the S-parameter). This uses absolute port numbers.
maxTime
Type: SystemTimeSpan
The amount of time to wait before throwing an exception, if the measurement is not complete.
fetchResult
Type: NationalInstruments.ModularInstruments.NIRfpmRfpmSingleMeasurementResultComplexDouble
A RfpmMultipleMeasurementResultT object to contain the results of the fetch operation.

Return Value

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

Exceptions

ExceptionCondition
ObjectDisposedExceptionFetchSingleSParameter(String, String, TimeSpan, RfpmSingleMeasurementResultComplexDouble) was called after the associated NIRfpm or RfpmDriverUtility object was disposed.
ArgumentException The value for maxTime is invalid.
ArgumentNullException The value for stimulusPort is .

-or-

The value for responsePort is .
SelectorNameException The value for stimulusPort is invalid.

-or-

The value for stimulusPort is unknown.

-or-

The value for responsePort is invalid.

-or-

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

Remarks

The S-parameter returned is selected using the stimulus port and response port. If stimulusPort = "port3" and responsePort = "port5", the fetch will return S53.

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

The S-parameter returned is selected using the stimulus port and response port. If stimulusPort = "port3" and responsePort = "port5", the fetch will return S53.

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