Returns the occupied bandwidth, absolute power, start frequency, and stop frequency of a component carrier or subblock.
Use "subblock<n>" as the selector string to read results from this function.

Syntax

int32 __stdcall RFmxNR_OBWFetchMeasurement(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *occupiedBandwidth, float64 *absolutePower, float64 *startFrequency, float64 *stopFrequency)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function.

selectorString[in]char

This parameter specifies a Selector String comprising of the signal name, result name, and subblock 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. The default value is "" (empty string).
Example:
"subblock0"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxNR_BuildSubblockString function to build the selector string.

timeout[in]float64

This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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. The default value is 10.

occupiedBandwidth[out]float64 *

This parameter returns the bandwidth that occupies the specified percentage of the total power of the signal. This value is expressed in Hz. The occupied bandwidth is calculated using the following equation: Occupied bandwidth = Stop frequency - Start frequency

absolutePower[out]float64 *

This parameter returns the power measured over the integration bandwidth of the component carrier. This value is expressed in dBm.

startFrequency[out]float64 *

This parameter returns the start frequency of the occupied bandwidth of carrier/subblock. This value is expressed in Hz.

stopFrequency[out]float64 *

This parameter returns the stop frequency of the occupied bandwidth of carrier/subblock. This value is expressed in Hz.

Returns

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 RFmxNR_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors