Skip to content

NI RFmx WLAN Fetch OFDM Modacc Functions

Dane Stull edited this page Feb 23, 2022 · 3 revisions

Fetch OFDM ModAcc Functions

RFmxWLAN_OFDMModAccFetchCompositeRMSEVM

int32 __stdcall RFmxWLAN_OFDMModAccFetchCompositeRMSEVM (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* compositeRMSEVMMean, float64* compositeDataRMSEVMMean, float64* compositePilotRMSEVMMean);

Purpose

Fetches the composite RMS EVM results.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
compositeRMSEVMMean float64* Returns the RMS EVM of all subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the composite RMS EVM results computed for each averaging count.
compositeDataRMSEVMMean float64* Returns the RMS EVM of data-subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the composite data RMS EVM results computed for each averaging count.
compositePilotRMSEVMMean float64* Returns the RMS EVM of pilot-subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the composite pilot RMS EVM results computed for each averaging count.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchStreamRMSEVM

int32 __stdcall RFmxWLAN_OFDMModAccFetchStreamRMSEVM (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* streamRMSEVMMean, float64* streamDataRMSEVMMean, float64* streamPilotRMSEVMMean);

Purpose

Fetches the stream RMS EVM results. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
streamRMSEVMMean float64* Returns the stream RMS EVM of all subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of stream RMS EVM results computed for each averaging count. This value is expressed as a percentage or in dB.
streamDataRMSEVMMean float64* Returns the stream RMS EVM of data subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of data stream RMS EVM results computed for each averaging count. This value is expressed as a percentage or in dB.
streamPilotRMSEVMMean float64* Returns the stream RMS EVM of pilot subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of pilot stream RMS EVM results computed for each averaging count. This value is expressed as a percentage or in dB.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchChainRMSEVM

int32 __stdcall RFmxWLAN_OFDMModAccFetchChainRMSEVM (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* chainRMSEVMMean, float64* chainDataRMSEVMMean, float64* chainPilotRMSEVMMean);

Purpose

Fetches the chain RMS EVM results. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
chainRMSEVMMean float64* Returns the chain RMS EVM of all subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of chain RMS EVM results computed for each averaging count. This value is expressed as a percentage or in dB.
chainDataRMSEVMMean float64* Returns the chain RMS EVM of data subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of data chain RMS EVM results computed for each averaging count. This value is expressed as a percentage or in dB.
chainPilotRMSEVMMean float64* Returns the chain RMS EVM of pilot subcarriers in all OFDM symbols. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of pilot chain RMS EVM results computed for each averaging count. This value is expressed as a percentage or in dB.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserStreamRMSEVM

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserStreamRMSEVM (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* userStreamRMSEVMMean, float64* userStreamDataRMSEVMMean, float64* userStreamPilotRMSEVMMean);

Purpose

Fetches the stream RMS EVM results for the specified user. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
userStreamRMSEVMMean float64* Returns the RMS EVM of all subcarriers in all OFDM symbols for the specified user. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the user stream RMS EVM computed for each averaging count.
userStreamDataRMSEVMMean float64* Returns the RMS EVM of data-subcarriers in all OFDM symbols for the specified user. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the user stream data RMS EVM computed for each averaging count.
userStreamPilotRMSEVMMean float64* Returns the RMS EVM of pilot-subcarriers in all OFDM symbols for the specified user. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the user stream pilot RMS EVM computed for each averaging count.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchFrequencyErrorMean

int32 __stdcall RFmxWLAN_OFDMModAccFetchFrequencyErrorMean (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* frequencyErrorMean);

Purpose

Fetches the carrier frequency error of the transmitter. Use "segment<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0"
"signal::sig1/segment0"
"result::r1/segment0"
"signal::sig1/result::r1/segment0"
You can use the RFmxWLAN_BuildSegmentString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
frequencyErrorMean float64* Returns the carrier frequency error of the transmitter. This value is expressed in Hz. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the mean of the carrier frequency error results computed for each averaging count.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchFrequencyErrorCCDF10Percent

int32 __stdcall RFmxWLAN_OFDMModAccFetchFrequencyErrorCCDF10Percent (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* frequencyErrorCCDF10Percent);

Purpose

Fetches the 10% point of the complementary cumulative distribution function (CCDF) of frequency error across the number of iterations. Use "segment<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0"
"signal::sig1/segment0"
"result::r1/segment0"
"signal::sig1/result::r1/segment0"
You can use the RFmxWLAN_BuildSegmentString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
frequencyErrorCCDF10Percent float64* Returns the 10% point of the CCDF of absolute frequency error. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, the CCDF is computed over each averaging count. This value is expressed in Hz.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSymbolClockErrorMean

int32 __stdcall RFmxWLAN_OFDMModAccFetchSymbolClockErrorMean (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* symbolClockErrorMean);

Purpose

Fetches the symbol clock error of the transmitter. Use "segment<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0"
"signal::sig1/segment0"
"result::r1/segment0"
"signal::sig1/result::r1/segment0"
You can use the RFmxWLAN_BuildSegmentString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
symbolClockErrorMean float64* Returns the symbol clock error of the transmitter. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the symbol clock error results computed for each averaging count. This value is expressed in parts per million (ppm).

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchIQImpairments

int32 __stdcall RFmxWLAN_OFDMModAccFetchIQImpairments (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* relativeIQOriginOffsetMean, float64* IQGainImbalanceMean, float64* IQQuadratureErrorMean, float64* absoluteIQOriginOffsetMean, float64* IQTimingSkewMean);

Purpose

Fetches the I/Q Impairment results for the OFDMModAcc measurement. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
relativeIQOriginOffsetMean float64* Returns the relative I/Q origin offset, which is the ratio of the power of the DC subcarrier to the total power of all the subcarriers. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the mean of the relative I/Q origin offset computed for each averaging count. This value is expressed in dB.
IQGainImbalanceMean float64* Returns the I/Q gain imbalance, which is the ratio of the RMS amplitude of the in-phase (I) component of the signal to the RMS amplitude of the quadrature-phase (Q) component of the signal. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the mean of the I/Q gain imbalance computed for each averaging count. This value is expressed in dB.
IQQuadratureErrorMean float64* Returns the I/Q quadrature error, which is a measure of deviation of the phase difference between the quadrature-phase (Q) and the in-phase (I) component of the signal from 90 degrees. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the I/Q quadrature error computed for each averaging count. This value is expressed in degrees.
absoluteIQOriginOffsetMean float64* Returns the absolute I/Q origin offset, which is the power of the DC subcarrier. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the mean of the absolute I/Q origin offset computed for each averaging count. This value is expressed in dBm.
IQTimingSkewMean float64* Returns the I/Q timing skew, which is the difference between the group delay of the in-phase (I) and quadrature (Q) components of the signal. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the mean of the I/Q timing skew computed for each averaging count. This value is expressed in seconds.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSpectralFlatness

int32 __stdcall RFmxWLAN_OFDMModAccFetchSpectralFlatness (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* spectralFlatnessMargin, int32* spectralFlatnessMarginSubcarrierIndex);

Purpose

Fetches the spectral flatness margin results. Use "segment<n>/chain<k>/stream<l>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, chain number, and stream number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0/chain0/stream0"
"signal::sig1/segment0/chain0/stream0"
"signal::sig1/result::r1/segment0/chain0/stream0"
"result::r1/segment0/chain0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
spectralFlatnessMargin float64* Returns the spectral flatness margin, which is the minimum of the upper and lower spectral flatness margins. The upper spectral flatness margin is the minimum difference between the upper mask and the spectral flatness across subcarriers. The lower spectral flatness margin is the minimum difference between the spectral flatness and the lower mask across subcarriers. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, the spectral flatness is computed using the mean of the channel frequency response magnitude computed for each averaging count. This value is expressed in dB.
spectralFlatnessMarginSubcarrierIndex int32* Returns the subcarrier index corresponding to the spectralFlatnessMargin parameter.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchNumberofSymbolsUsed

int32 __stdcall RFmxWLAN_OFDMModAccFetchNumberofSymbolsUsed (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* numberOfSymbolsUsed);

Purpose

Fetches the number of OFDM symbols used for EVM measurement.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
numberOfSymbolsUsed int32* Returns the number of OFDM symbols used by the measurement.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchNumberOfSpaceTimeStreams

int32 __stdcall RFmxWLAN_OFDMModAccFetchNumberOfSpaceTimeStreams (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* numberOfSpaceTimeStreams);

Purpose

Fetches the number of space time streams. Use "user<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and user number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0"
"signal::sig1/user0"
"signal::sig1/result::r1/user0"
"result::r1/user0"
You can use the RFmxWLAN_BuildUserString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
numberOfSpaceTimeStreams int32* Returns the number of space time streams.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPPDUType

int32 __stdcall RFmxWLAN_OFDMModAccFetchPPDUType (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* PPDUType);

Purpose

Fetches the PPDU type.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PPDUType int32* Returns the PPDU type.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchMCSIndex

int32 __stdcall RFmxWLAN_OFDMModAccFetchMCSIndex (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* MCSIndex);

Purpose

Fetches the MCS index. Use "user<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and user number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0"
"signal::sig1/user0"
"signal::sig1/result::r1/user0"
"result::r1/user0"
You can use the RFmxWLAN_BuildUserString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
MCSIndex int32* Returns the MCS index or the data rate. The MCS index or data rate for various standard signals are decoded as follows:
Standard Field
802.11a, 802.11j, 802.11p The data rate is decoded from the SIGNAL field.
802.11n The MCS index is decoded from the HT-SIG field.
802.11ac The MCS index is decoded from the VHT-SIG-A field.
802.11ax SU and Extended Range SU PPDU The MCS index is decoded from the HE-SIG-A field.
802.11ax MU PPDU The MCS index is decoded from the HE-SIG-B field.
802.11be MU PPDU The MCS index is decoded from the EHT-SIG field.
For 802.11a, 802.11j, and 802.11p signals, the following MCS indices corresponds to their data rates:
MCS Data Rate
0 1.5 Mbps, 3 Mbps, and 6 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
1 2.25 Mbps, 4.5 Mbps, and 9 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
2 3 Mbps, 6 Mbps, and 12 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
3 4.5 Mbps, 9 Mbps, and 18 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
4 6 Mbps, 12 Mbps, and 24 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
5 9 Mbps, 18 Mbps, and 36 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
6 12 Mbps, 24 Mbps, and 48 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.
7 13.5 Mbps, 27 Mbps, and 54 Mbps for channel bandwidths of 5 MHz, 10 MHz, and 20 MHz, respectively.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchRUOffsetAndSize

int32 __stdcall RFmxWLAN_OFDMModAccFetchRUOffsetAndSize (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* RUOffset, int32* RUSize);

Purpose

Fetches the RU offset and the RU size of the specified user. Use "user<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and user number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0"
"signal::sig1/user0"
"signal::sig1/result::r1/user0"
"result::r1/user0"
You can use the RFmxWLAN_BuildUserString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
RUOffset int32* Returns the location of RU for the specified user in terms of the index of a 26-tone RU, assuming the entire bandwidth is composed of 26-tone RUs.
RUSize int32* Returns the RU size for the specified user.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchNumberOfUsers

int32 __stdcall RFmxWLAN_OFDMModAccFetchNumberOfUsers (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* numberOfUsers);

Purpose

Fetches the number of users.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
numberOfUsers int32* Returns the number of users which is derived for the following standards.
Standard Derivation
802.11ac Derived from the VHT-SIG-A for VHT MU PPDU.
802.11ax Derived from the HE-SIG-B for HE MU PPDU.
802.11be Derived from the EHT-SIG for EHT MU PPDU.
For all other PPDUs, this property returns 1.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchNumberOfHESIGBSymbols

int32 __stdcall RFmxWLAN_OFDMModAccFetchNumberOfHESIGBSymbols (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* numberOfHESIGBSymbols);

Purpose

Fetches the number of HE-SIG-B symbols.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
numberOfHESIGBSymbols int32* Returns the number of HE-SIG-B symbols. This result is applicable for 802.11ax MU PPDU signals, and is decoded from the HE-SIG-A field.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchGuardIntervalType

int32 __stdcall RFmxWLAN_OFDMModAccFetchGuardIntervalType (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* guardIntervalType);

Purpose

Fetches the guard interval type.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
guardIntervalType int32* Returns the size of the guard interval of OFDM symbols.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchLTFSize

int32 __stdcall RFmxWLAN_OFDMModAccFetchLTFSize (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* LTFSize);

Purpose

Fetches the HE-LTF or EHT-LTF size for 802.11ax or 802.11be, respectively.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
LTFSize int32* Returns the HE-LTF or EHT-LTF size. This result is applicable only to 802.11ax and 802.11be signals.
FMXWLAN_VAL_OFDM_LTF_SIZE_NOT_APPLICABLE (-1) Result is not applicable.
FMXWLAN_VAL_OFDM_LTF_SIZE_4X (0) The HE-LTF or EHT-LTF size is 4x.
FMXWLAN_VAL_OFDM_LTF_SIZE_2X (1) The HE-LTF or EHT-LTF size is 2x.
FMXWLAN_VAL_OFDM_LTF_SIZE_1X (2) The HE-LTF or EHT-LTF size is 1x.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchLSIGParityCheckStatus

int32 __stdcall RFmxWLAN_OFDMModAccFetchLSIGParityCheckStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* LSIGParityCheckStatus);

Purpose

Fetches the L-SIG parity check status.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
LSIGParityCheckStatus int32* Returns whether the parity check has passed either for the SIGNAL field of the 802.11a/g waveform or for the L-SIG field of the 802.11n/802.11ac/802.11ax/802.11be waveforms.
RFMXWLAN_VAL_OFDMMODACC_L_SIG_PARITY_CHECK_STATUS_NOT_APPLICABLE (-1) Returns that the parity check is invalid for the current waveform.
RFMXWLAN_VAL_OFDMMODACC_L_SIG_PARITY_CHECK_STATUS_FAIL (0) Returns that the parity check failed.
RFMXWLAN_VAL_OFDMMODACC_L_SIG_PARITY_CHECK_STATUS_PASS (1) Returns that the parity check passed.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSIGCRCStatus

int32 __stdcall RFmxWLAN_OFDMModAccFetchSIGCRCStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* SIGCRCStatus);

Purpose

Fetches the SIG CRC Status.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
SIGCRCStatus int32* Returns whether the cyclic redundancy check (CRC) has passed either for the HT-SIG field of the 802.11n waveform, for the VHT-SIG-A field of the 802.11ac waveform, or for the HE-SIG-A field of the 802.11ax waveform.
RFMXWLAN_VAL_OFDMMODACC_SIG_CRC_STATUS_NOT_APPLICABLE (-1) Returns that the SIG CRC is invalid for the current waveform.
RFMXWLAN_VAL_OFDMMODACC_SIG_CRC_STATUS_FAIL (0) Returns that the SIG CRC failed.
RFMXWLAN_VAL_OFDMMODACC_SIG_CRC_STATUS_PASS (1) Returns that the SIG CRC passed.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSIGBCRCStatus

int32 __stdcall RFmxWLAN_OFDMModAccFetchSIGBCRCStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* SIGBCRCStatus);

Purpose

Fetches the SIG-B CRC Status.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
SIGBCRCStatus int32* Returns whether the cyclic redundancy check (CRC) has passed for the HE-SIG-B field of the 802.11ax MU PPDU waveform.
RFMXWLAN_VAL_OFDMMODACC_SIG_B_CRC_STATUS_NOT_APPLICABLE (-1) Returns that the SIG-B CRC is invalid for the current waveform.
RFMXWLAN_VAL_OFDMMODACC_SIG_B_CRC_STATUS_FAIL (0) Returns that the SIG-B CRC failed.
RFMXWLAN_VAL_OFDMMODACC_SIG_B_CRC_STATUS_PASS (1) Returns that the SIG-B CRC passed.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPSDUCRCStatus

int32 __stdcall RFmxWLAN_OFDMModAccFetchPSDUCRCStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* PSDUCRCStatus);

Purpose

Fetches the PLCP service data unit (PSDU) CRC status.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PSDUCRCStatus int32* Returns the PSDU CRC status.
RFMXWLAN_VAL_OFDMMODACC_PSDU_CRC_STATUS_FAIL (0) Indicates that the PSDU CRC failed.
RFMXWLAN_VAL_OFDMMODACC_PSDU_CRC_STATUS_PASS (1) Indicates that the PSDU CRC passed.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPEDuration

int32 __stdcall RFmxWLAN_OFDMModAccFetchPEDuration (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* PEDuration);

Purpose

Fetches the duration of the packet extension field.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PEDuration float64* Returns the duration of the packet extension field for the 802.11ax and 802.11be signals. This parameter is applicable only when you set the RFMXWLAN_ATTR_OFDM_HEADER_DECODING_ENABLED attribute to RFMXWLAN_VAL_OFDM_HEADER_DECODING_ENABLED_TRUE. This value is expressed in seconds.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDataAveragePower

int32 __stdcall RFmxWLAN_OFDMModAccFetchDataAveragePower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* dataAveragePowerMean);

Purpose

Fetches the average power of the data field. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
dataAveragePowerMean float64* Returns the average power of the data field. This value is expressed in dBm. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the data average power results computed for each averaging count.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDataPeakPower

int32 __stdcall RFmxWLAN_OFDMModAccFetchDataPeakPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* dataPeakPowerMaximum);

Purpose

Fetches the peak power of the data field. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
dataPeakPowerMaximum float64* Returns the peak power of the data field. This value is expressed in dBm. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns an array of the maximum of the data peak power results computed for each averaging count.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPPDUAveragePower

int32 __stdcall RFmxWLAN_OFDMModAccFetchPPDUAveragePower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* PPDUAveragePowerMean);

Purpose

Fetches the average power of the PPDU. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PPDUAveragePowerMean float64* Returns the average power of the PPDU. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the PPDU average power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPPDUPeakPower

int32 __stdcall RFmxWLAN_OFDMModAccFetchPPDUPeakPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* PPDUPeakPowerMaximum);

Purpose

Fetches the peak power of the PPDU. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PPDUPeakPowerMaximum float64* Returns the peak power of the PPDU. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the PPDU peak power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPEAveragePower

int32 __stdcall RFmxWLAN_OFDMModAccFetchPEAveragePower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* PEAveragePowerMean);

Purpose

Fetches the average power of the packet extension field. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PEAveragePowerMean float64* Returns the average power of the packet extension field. This parameter is applicable for 802.11ax signals. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the packet extension field average power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPEPeakPower

int32 __stdcall RFmxWLAN_OFDMModAccFetchPEPeakPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* PEPeakPowerMaximum);

Purpose

Fetches the peak power of the packet extension field. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
PEPeakPowerMaximum float64* Returns the peak power of the packet extension field. This parameter is applicable for 802.11ax signals. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the PE field peak power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreambleAveragePowersCommon

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreambleAveragePowersCommon (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* LSTFAveragePowerMean, float64* LLTFAveragePowerMean, float64* LSIGAveragePowerMean);

Purpose

Fetches the average power of the preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
LSTFAveragePowerMean float64* Returns the average power of the L-STF or STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the L-STF or STF average power results computed for each averaging count. This value is expressed in dBm.
LLTFAveragePowerMean float64* Returns the average power of the L-LTF or LTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the L-LTF or LTF average power results computed for each averaging count. This value is expressed in dBm.
LSIGAveragePowerMean float64* Returns the average power of the L-SIG or SIGNAL field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the L-SIG or SIGNAL field average power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreamblePeakPowersCommon

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreamblePeakPowersCommon (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* LSTFPeakPowerMaximum, float64* LLTFPeakPowerMaximum, float64* LSIGPeakPowerMaximum);

Purpose

Fetches the peak power of the preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
LSTFPeakPowerMaximum float64* Returns the peak power of the L-STF or STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the L-STF or STF peak power results computed for each averaging count. This value is expressed in dBm.
LLTFPeakPowerMaximum float64* Returns the peak power of the L-LTF or LTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the L-LTF or LTF peak power results computed for each averaging count. This value is expressed in dBm.
LSIGPeakPowerMaximum float64* Returns the peak power of the L-SIG or SIGNAL field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the L-SIG or SIGNAL field peak power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreambleAveragePowers802_11n

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreambleAveragePowers802_11n (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* HTSIGAveragePowerMean, float64* HTSTFAveragePowerMean, float64* HTDLTFAveragePowerMean, float64* HTELTFAveragePowerMean);

Purpose

Fetches the average power of the 802.11n specific preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
HTSIGAveragePowerMean float64* Returns the average power of the HT-SIG field. When you set the OFDMModAcc Averaging Enabled attribute to true, this parameter returns the mean of the HT-SIG field average power results computed for each averaging count. This value is expressed in dBm.
HTSTFAveragePowerMean float64* Returns the average power of the HT-STF field. When you set the OFDMModAcc Averaging Enabled attribute to true, this parameter returns the mean of the HT-STF average power results computed for each averaging count. This value is expressed in dBm.
HTDLTFAveragePowerMean float64* Returns the average power of the HT-DLTF. When you set the OFDMModAcc Averaging Enabled attribute to true, this parameter returns the mean of the HT-DLTF average power results computed for each averaging count. This value is expressed in dBm.
HTELTFAveragePowerMean float64* Returns the average power of the HT-ELTF field. When you set the OFDMModAcc Averaging Enabled attribute to true, this parameter returns the mean of the HT-ELTF average power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreamblePeakPowers802_11n

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreamblePeakPowers802_11n (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* HTSIGPeakPowerMaximum, float64* HTSTFPeakPowerMaximum, float64* HTDLTFPeakPowerMaximum, float64* HTELTFPeakPowerMaximum);

Purpose

Fetches the peak power of the 802.11n specific preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
HTSIGPeakPowerMaximum float64* Returns the peak power of the HT-SIG field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HT-SIG field peak power results computed for each averaging count. This value is expressed in dBm.
HTSTFPeakPowerMaximum float64* Returns the peak power of the HT-STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HT-STF peak power results computed for each averaging count. This value is expressed in dBm.
HTDLTFPeakPowerMaximum float64* Returns the peak power of the HT-DLTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HT-DLTF peak power results computed for each averaging count. This value is expressed in dBm.
HTELTFPeakPowerMaximum float64* Returns the peak power of the HT-ELTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HT-ELTF peak power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreambleAveragePowers802_11ac

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreambleAveragePowers802_11ac (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* VHTSIGAAveragePowerMean, float64* VHTSTFAveragePowerMean, float64* VHTLTFAveragePowerMean, float64* VHTSIGBAveragePowerMean);

Purpose

Fetches the average power of the 802.11ac specific preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
VHTSIGAAveragePowerMean float64* Returns the average power of the VHT-SIG-A field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the VHT-SIG-A field average power results computed for each averaging count. This value is expressed in dBm.
VHTSTFAveragePowerMean float64* Returns the average power of the VHT-STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the VHT-STF average power results computed for each averaging count. This value is expressed in dBm.
VHTLTFAveragePowerMean float64* Returns the average power of the VHT-LTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this paramter returns the mean of the VHT-LTF average power results computed for each averaging count. This value is expressed in dBm.
VHTSIGBAveragePowerMean float64* Returns the average power of the VHT-SIG-B field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the VHT-SIG-B field average power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreamblePeakPowers802_11ac

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreamblePeakPowers802_11ac (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* VHTSIGAPeakPowerMaximum, float64* VHTSTFPeakPowerMaximum, float64* VHTLTFPeakPowerMaximum, float64* VHTSIGBPeakPowerMaximum);

Purpose

Fetches the peak power of the 802.11ac specific preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
VHTSIGAPeakPowerMaximum float64* Returns the peak power of the VHT-SIG-A field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this attribute returns the maximum of the VHT-SIG-A field peak power results computed for each averaging count. This value is expressed in dBm.
VHTSTFPeakPowerMaximum float64* Returns the peak power of the VHT-STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the VHT-STF peak power results computed for each averaging count. This value is expressed in dBm.
VHTLTFPeakPowerMaximum float64* Returns the peak power of the VHT-LTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the VHT-LTF peak power results computed for each averaging count. This value is expressed in dBm.
VHTSIGBPeakPowerMaximum float64* Returns the peak power of the VHT-SIG-B field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the VHT-SIG-B field peak power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreambleAveragePowers802_11ax

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreambleAveragePowers802_11ax (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* RLSIGAveragePowerMean, float64* HESIGAAveragePowerMean, float64* HESIGBAveragePowerMean, float64* HESTFAveragePowerMean, float64* HELTFAveragePowerMean);

Purpose

Fetches the average power of the 802.11ax specific preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
RLSIGAveragePowerMean float64* Returns the average power of the RL-SIG field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the RL-SIG field average power results computed for each averaging count. This value is expressed in dBm.
HESIGAAveragePowerMean float64* Returns the average power of the HE-SIG-A field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the HE-SIG-A field average power results computed for each averaging count. This value is expressed in dBm.
HESIGBAveragePowerMean float64* Returns the average power of the HE-SIG-B field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the HE-SIG-B field average power results computed for each averaging count. This value is expressed in dBm.
HESTFAveragePowerMean float64* Returns the average power of the HE-STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the HE-STF average power results computed for each averaging count. This value is expressed in dBm.
HELTFAveragePowerMean float64* Returns the average power of the HE-LTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the HE-LTF average power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreamblePeakPowers802_11ax

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreamblePeakPowers802_11ax (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* RLSIGPeakPowerMaximum, float64* HESIGAPeakPowerMaximum, float64* HESIGBPeakPowerMaximum, float64* HESTFPeakPowerMaximum, float64* HELTFPeakPowerMaximum);

Purpose

Fetches the peak power of the 802.11ax specific preamble fields. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
RLSIGPeakPowerMaximum float64* Returns the peak power of the RL-SIG field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the RL-SIG field peak power results computed for each averaging count. This value is expressed in dBm.
HESIGAPeakPowerMaximum float64* Returns the peak power of the HE-SIG-A field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HE-SIG-A field peak power results computed for each averaging count. This value is expressed in dBm.
HESIGBPeakPowerMaximum float64* Returns the peak power of the HE-SIG-B field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HE-SIG-B field peak power results computed for each averaging count. This value is expressed in dBm.
HESTFPeakPowerMaximum float64* Returns the peak power of the HE-STF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HE-STF peak power results computed for each averaging count. This value is expressed in dBm.
HELTFPeakPowerMaximum float64* Returns the peak power of the HE-LTF field. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the maximum of the HE-LTF peak power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchCustomGatePowersArray

int32 __stdcall RFmxWLAN_OFDMModAccFetchCustomGatePowersArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 averagePowerMean[], float64 peakPowerMaximum[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the average and peak power of the custom gates. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
averagePowerMean float64[] Returns an array of average powers of the custom gates. This value is expressed in dBm. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns an array of the mean of the average custom gate power results computed for each averaging count.
peakPowerMaximum float64[] Returns an array of peak powers of the custom gates. This value is expressed in dBm. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns an array of the maximum of the peak custom gate power results computed for each averaging count.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchCrossPower

int32 __stdcall RFmxWLAN_OFDMModAccFetchCrossPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* crossPowerMean);

Purpose

Fetches the cross power. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
crossPowerMean float64* Returns the cross power. The cross power for chain x is the power contribution from streams other than stream x in the chain. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the cross power results computed for each averaging count. This value is expressed in dB.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserPower

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* userPowerMean);

Purpose

Fetches the user power. Use "user<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and user number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0"
"signal::sig1/user0"
"signal::sig1/result::r1/user0"
"result::r1/user0"
You can use the RFmxWLAN_BuildUserString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
userPowerMean float64* Returns the user power. User power is the frequency domain power measured over subcarriers occupied by a given user. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this parameter returns the mean of the user power results computed for each averaging count. This value is expressed in dBm.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUnusedToneError

int32 __stdcall RFmxWLAN_OFDMModAccFetchUnusedToneError (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* unusedToneErrorMargin, int32* unusedToneErrorMarginRUIndex);

Purpose

Fetches the unused tone error margin results. Refer to Unused Tone Error Measurement for more information. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
unusedToneErrorMargin float64* Describes error conditions that occur before this node runs. This input provides standard error in functionality.
unusedToneErrorMarginRUIndex int32* Returns the 26-tone RU index corresponding to the unusedToneErrorMargin parameter.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUnusedToneErrorMarginPerRU

int32 __stdcall RFmxWLAN_OFDMModAccFetchUnusedToneErrorMarginPerRU (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 unusedToneErrorMarginPerRU[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the unused tone error margin result per RU. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
unusedToneErrorMarginPerRU float64[] Returns an array of unused tone error margin per RU, which is the difference between the unused tone error mask and the unused tone error for each RU. This value is expressed in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDataConstellationTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDataConstellationTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, NIComplexSingle dataConstellation[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the constellation trace for the data-subcarriers.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
dataConstellation NIComplexSingle[] Returns the demodulated QAM symbols from all the data-subcarriers in all the OFDM symbols.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPilotConstellationTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchPilotConstellationTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, NIComplexSingle pilotConstellation[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the constellation trace for the pilot-subcarriers. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
pilotConstellation NIComplexSingle[] Returns the demodulated QAM symbols from all the pilot-subcarriers in all OFDM symbols.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserDataConstellationTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserDataConstellationTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, NIComplexSingle userDataConstellation[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the constellation trace for the data-subcarriers of each user. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
userDataConstellation NIComplexSingle[] Returns the demodulated QAM symbols from all the data-subcarriers in all of the OFDM symbols for each user.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserPilotConstellationTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserPilotConstellationTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, NIComplexSingle userPilotConstellation[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the constellation trace for the pilot-subcarriers of each user. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
userPilotConstellation NIComplexSingle[] Returns the demodulated QAM symbols from all the pilot-subcarriers in all of the OFDM symbols for each user.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchStreamRMSEVMPerSubcarrierMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchStreamRMSEVMPerSubcarrierMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 streamRMSEVMPerSubcarrierMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream RMS EVM per subcarrier trace. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
streamRMSEVMPerSubcarrierMean float32[] Returns the stream RMS EVM for each subcarrier. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchStreamRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchStreamRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 streamRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream RMS EVM per symbol trace. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
streamRMSEVMPerSymbolMean float32[] Returns the stream RMS EVM of each OFDM symbol. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchStreamDataRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchStreamDataRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 streamDataRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream data subcarriers RMS EVM per symbol trace. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
streamDataRMSEVMPerSymbolMean float32[] Returns the stream data subcarriers RMS EVM of each OFDM symbol. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchStreamPilotRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchStreamPilotRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 streamPilotRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream pilot subcarriers RMS EVM per symbol trace. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
streamPilotRMSEVMPerSymbolMean float32[] Returns the stream pilot subcarriers RMS EVM of each OFDM symbol. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchChainRMSEVMPerSubcarrierMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchChainRMSEVMPerSubcarrierMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 chainRMSEVMPerSubcarrierMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the chain RMS EVM per subcarrier trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the chain RMS EVM per subcarrier computed for each averaging count. Use "segment(n)/chain(k)" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
chainRMSEVMPerSubcarrierMean float32[] Returns an array of chain RMS EVM of each subcarrier. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchChainRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchChainRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 chainRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the chain RMS EVM per symbol trace. When you set the When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the chain RMS EVM per symbol computed for each averaging count. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
chainRMSEVMPerSymbolMean float32[] Returns an array of chain RMS EVM of OFDM symbol. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchChainDataRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchChainDataRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 chainDataRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the chain data-subcarriers RMS EVM per symbol trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the chain data RMS EVM per symbol computed for each averaging count. Use "segment(n)/chain(k)" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
chainDataRMSEVMPerSymbolMean float32[] Returns an array of chain data-subcarriers RMS EVM of each OFDM symbol. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchChainPilotRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchChainPilotRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 chainPilotRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the chain pilot-subcarriers RMS EVM per symbol trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the chain pilot RMS EVM per symbol computed for each averaging count. Use "segment(n)/chain(k)" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
chainPilotRMSEVMPerSymbolMean float32[] Returns an array of chain pilot-subcarriers RMS EVM of each OFDM symbol. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserStreamRMSEVMPerSubcarrierMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserStreamRMSEVMPerSubcarrierMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 userStreamRMSEVMPerSubcarrierMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream RMS EVM per subcarrier trace for each user. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the user stream RMS EVM per subcarrier computed for each averaging count. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
userStreamRMSEVMPerSubcarrierMean float32[] Returns the user stream RMS EVM for each subcarrier. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserStreamRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserStreamRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 userStreamRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream RMS EVM per symbol trace for each user. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the user stream RMS EVM per symbol computed for each averaging count. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
userStreamRMSEVMPerSymbolMean float32[] Returns the stream RMS EVM of each OFDM symbol for each user. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserStreamDataRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserStreamDataRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 userStreamDataRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream data-subcarriers RMS EVM per symbol trace for each user. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the user stream data RMS EVM per symbol computed for each averaging count. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
userStreamDataRMSEVMPerSymbolMean float32[] Returns the stream data subcarriers RMS EVM of each OFDM symbol for each user. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUserStreamPilotRMSEVMPerSymbolMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUserStreamPilotRMSEVMPerSymbolMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 userStreamPilotRMSEVMPerSymbolMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream pilot-subcarriers RMS EVM per symbol trace for each user. Use "user<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0/stream0"
"signal::sig1/user0/stream0"
"signal::sig1/result::r1/user0/stream0"
"result::r1/user0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
userStreamPilotRMSEVMPerSymbolMean float32[] Returns the stream pilot subcarriers RMS EVM of each OFDM symbol for each user. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSubcarrierStreamEVMPerSymbolTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchSubcarrierStreamEVMPerSymbolTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 subcarrierIndex, float64* x0, float64* dx, float32 subcarrierStreamEVMPerSymbol[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream EVM per symbol trace for a subcarrier. Use "segment(n)/stream(k)" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
subcarrierIndex int32 Specifies the subcarrier index for which to fetch the trace.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
subcarrierStreamEVMPerSymbol float32[] Returns the stream EVM of each OFDM symbol for the specified subcarrier index. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSymbolStreamEVMPerSubcarrierTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchSymbolStreamEVMPerSubcarrierTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 symbolIndex, float64* x0, float64* dx, float32 symbolStreamEVMPerSubcarrier[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the stream EVM per subcarrier trace for a symbol. Use "segment<n>/stream<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/stream0"
"signal::sig1/segment0/stream0"
"signal::sig1/result::r1/segment0/stream0"
"result::r1/segment0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
symbolIndex int32 Specifies the symbol index for which to fetch the trace.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
symbolStreamEVMPerSubcarrier float32[] Returns the stream EVM for each subcarrier for the specified symbol index. This value is expressed as a percentage or in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSymbolChainEVMPerSubcarrierTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchSymbolChainEVMPerSubcarrierTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 symbolIndex, float64* x0, float64* dx, float32 symbolChainEVMPerSubcarrier[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the chain EVM per subcarrier trace for a symbol. For symbol indices outside the measurement interval, the trace value is NaN. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
symbolIndex int32 Specifies the symbol index for which to fetch the trace.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
symbolChainEVMPerSubcarrier float32[] Returns an array of chain EVM for each subcarrier for the specified symbol index. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSubcarrierChainEVMPerSymbolTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchSubcarrierChainEVMPerSymbolTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 subcarrierIndex, float64* x0, float64* dx, float32 subcarrierChainEVMPerSymbol[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the chain EVM per symbol trace for a subcarrier. For unoccupied subcarriers, the trace value is NaN. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
subcarrierIndex int32 Specifies the subcarrier index for which the trace is fetched.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
subcarrierChainEVMPerSymbol float32[] Returns an array of chain EVM of each OFDM symbol for the specified subcarrier index. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_PERCENTAGE, the measurement returns this result as a percentage. When you set the RFMXWLAN_ATTR_OFDMMODACC_EVM_UNIT attribute to RFMXWLAN_VAL_OFDMMODACC_EVM_UNIT_DB, the measurement returns this result in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchSpectralFlatnessMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchSpectralFlatnessMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectralFlatnessMean[], float32 spectralFlatnessLowerMask[], float32 spectralFlatnessUpperMask[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the spectral flatness trace, and the lower and upper spectral flatness mask traces. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the spectral flatness trace computed on the mean of the channel estimates computed for each averaging count. Use "segment<n>/chain<k>/stream<l>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, chain number, and stream number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0/chain0/stream0"
"signal::sig1/segment0/chain0/stream0"
"signal::sig1/result::r1/segment0/chain0/stream0"
"result::r1/segment0/chain0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
spectralFlatnessMean float32[] Returns an array of spectral flatness for each subcarrier. This value is expressed in dB.
spectralFlatnessLowerMask float32[] Returns an array of spectral flatness lower mask for each subcarrier. This value is expressed in dB.
spectralFlatnessUpperMask float32[] Returns an array of spectral flatness upper mask for each subcarrier. This value is expressed in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchCommonPilotErrorTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchCommonPilotErrorTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 commonPilotErrorMagnitude[], float32 commonPilotErrorPhase[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the common pilot error magnitude and phase traces. Use "segment<n>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0"
"signal::sig1/segment0"
"result::r1/segment0"
"signal::sig1/result::r1/segment0"
You can use the RFmxWLAN_BuildSegmentString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
dx float64* Returns the OFDM symbol increment value. This value is always equal to 1.
commonPilotErrorMagnitude float32[] Returns an array of magnitude of the common pilot error for each OFDM symbol.
commonPilotErrorPhase float32[] Returns an array of phase of the common pilot error for each OFDM symbol. This value is expressed in degrees.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchPreambleFrequencyErrorTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchPreambleFrequencyErrorTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 preambleFrequencyError[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the preamble frequency error trace for signals containing an OFDM payload. Preamble frequency error computes the variations, across time, of the frequency error over initial 16us which comprises of the short training field (STF) and long training field (LTF) symbols.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the start time in seconds.
dx float64* Returns the time increment value. This value is the reciprocal of OFDM ModAcc processing rate.
preambleFrequencyError float32[] Returns the preamble frequency error at every sampling time. This value is expressed in Hz.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchChannelFrequencyResponseMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchChannelFrequencyResponseMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 channelFrequencyResponseMeanMagnitude[], float32 channelFrequencyResponseMeanPhase[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the channel frequency response trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the channel frequency response trace computed for each averaging count. Use "segment<n>/chain<k>/stream<l>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, chain number, and stream number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0/chain0/stream0"
"signal::sig1/segment0/chain0/stream0"
"signal::sig1/result::r1/segment0/chain0/stream0"
"result::r1/segment0/chain0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
channelFrequencyResponseMeanMagnitude float32[] Returns an array of magnitudes of the channel frequency response for each subcarrier. This value is expressed in dB.
channelFrequencyResponseMeanPhase float32[] Returns an array of deviation of the measured phase-response of the channel from the ideal linear phase response for all subcarriers. This value is expressed in degrees.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchIQGainImbalancePerSubcarrierMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchIQGainImbalancePerSubcarrierMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 IQGainImbalancePerSubcarrierMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the I/Q gain imbalance per subcarrier trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the I/Q gain imbalance computed for each averaging count. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
IQGainImbalancePerSubcarrierMean float32[] Returns an array of I/Q gain imbalance for each subcarrier. This value is expressed in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchIQQuadratureErrorPerSubcarrierMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchIQQuadratureErrorPerSubcarrierMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 IQQuadratureErrorPerSubcarrierMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the I/Q quadrature error per subcarrier trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the I/Q quadrature error computed for each averaging count. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
IQQuadratureErrorPerSubcarrierMean float32[] Returns an array of I/Q quadrature errors for each subcarrier. This value is expressed in degrees.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchUnusedToneErrorMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchUnusedToneErrorMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 unusedToneError[], float32 unusedToneErrorMask[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the unused tone error trace and the unused tone error mask trace. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the unused tone error computed for each averaging count. Use "segment<n>/chain<k>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, and chain number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"segment0/chain0"
"signal::sig1/segment0/chain0"
"signal::sig1/result::r1/segment0/chain0"
"result::r1/segment0/chain0"
You can use the RFmxWLAN_BuildChainString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting RU index. This value is always 0.
dx float64* Returns the RU increment value. This value is always 1.
unusedToneError float32[] Returns an array of unused tone error for each RU. This value is expressed in dB.
unusedToneErrorMask float32[] Returns an array of unused tone error mask for each RU. This value is expressed in dB.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedLSIGBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedLSIGBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedLSIGBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded L-SIG bits trace.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedLSIGBits int32[] Returns the array of bits in the SIGNAL field of the 802.11a/g waveform or the L-SIG field of the 802.11n/802.11ac/802.11ax/802.11be waveforms.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedSIGBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedSIGBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedSIGBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded SIG bits.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedSIGBits int32[] Returns an array of bits in the HT-SIG field of the 802.11n waveform, the VHT-SIG-A field of the 802.11ac waveform, or the HE-SIG-A field of the 802.11ax waveform.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedSIGBBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedSIGBBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedSIGBBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded SIG-B bits.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedSIGBBits int32[] Returns an array of bits in the VHT-SIG-B field of the 802.11ac waveform or the HE-SIG-B field of the 802.11ax waveform.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedUSIGBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedUSIGBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedUSIGBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded U-SIG bits trace.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedUSIGBits int32[] Returns the array of bits in the U-SIG field of the 802.11be waveform for all 80 MHz subblocks.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedEHTSIGBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedEHTSIGBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedEHTSIGBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded EHT-SIG bits trace.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWLAN_BuildSignalString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedEHTSIGBits int32[] Returns the array of bits in the EHT-SIG field of the 802.11be waveform for all 80 MHz subblocks.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedPSDUBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedPSDUBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedPSDUBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded PLCP service data unit (PSDU) bits.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and user number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0"
"signal::sig1/user0"
"signal::sig1/result::r1/user0"
"result::r1/user0"
You can use the RFmxWLAN_BuildUserString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedPSDUBits int32[] Returns an array of PSDU bits obtained after demodulation and decoding.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchDecodedServiceBitsTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchDecodedServiceBitsTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 decodedServiceBits[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the decoded Service bits.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, and user number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"user0"
"signal::sig1/user0"
"signal::sig1/result::r1/user0"
"result::r1/user0"
You can use the RFmxWLAN_BuildUserString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
decodedServiceBits int32[] Returns an array of Service bits obtained after demodulation and decoding.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxWLAN_OFDMModAccFetchGroupDelayMeanTrace

int32 __stdcall RFmxWLAN_OFDMModAccFetchGroupDelayMeanTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 groupDelayMean[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches the group delay trace. Group delay is computed from the channel frequency response. When you set the RFMXWLAN_ATTR_OFDMMODACC_AVERAGING_ENABLED attribute to RFMXWLAN_VAL_OFDMMODACC_AVERAGING_ENABLED_TRUE, this function returns the mean of the group delay trace computed for each averaging count. Use "segment<n>/chain<k>/stream<l>" as the selector string to read results from this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, segment number, chain number, and stream number. If you do not specify the signal name, the default signal instance is used.
Example:
"segment0/chain0/stream0"
"signal::sig1/segment0/chain0/stream0"
"signal::sig1/result::r1/segment0/chain0/stream0"
"result::r1/segment0/chain0/stream0"
You can use the RFmxWLAN_BuildStreamString function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns the starting subcarrier index.
dx float64* Returns the subcarrier increment value. This value is always 1.
groupDelayMean float32[] Returns an array of group delay responses. This value is expressed in seconds.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxWLAN_GetError function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally