RFmxLTE_OBWFetchMeasurement
- Updated2025-04-08
- 2 minute(s) read
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.
Refer to the LTE Occupied Bandwidth OBW topic for more information about OBW measurements.
Syntax
int32 __stdcall RFmxLTE_OBWFetchMeasurement(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *occupiedBandwidth, float64 *absolutePower, float64 *startFrequency, float64 *stopFrequency)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| 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 "subblock0". |
| 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 99 percentage of the total power of the signal within a carrier/subblock. |
| absolutePower | [out] | float64 * | This parameter returns the power measured over the integration bandwidth of the carrier. The carrier power is reported in dBm when you set the RFMXLTE_ATTR_ACP_POWER_UNITS attribute to dBm, and in dBm/Hz when you set the ACP Pwr Units attribute to dBm/Hz. |
| startFrequency | [out] | float64 * | This parameter returns the start frequency of the subblock. The occupied bandwidth of a carrier/subblock is calculated using the following equation: Stop frequency - Start frequency = Occupied bandwidth. |
| stopFrequency | [out] | float64 * | This parameter returns the stop frequency of the subblock. The occupied bandwidth of a carrier/subblock is calculated using the following equation: Stop frequency - Start frequency = Occupied bandwidth. |
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 RFmxLTE_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |