RFmxLTE_ACPFetchSubblockMeasurement
- Updated2025-04-08
- 2 minute(s) read
Returns the power, integration bandwidth, and center frequency of the subblock.
Use "subblock<n>" as the selector string to read results from this function.
Syntax
int32 __stdcall RFmxLTE_ACPFetchSubblockMeasurement(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *subblockPower, float64 *integrationBandwidth, float64 *frequency)
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. |
subblockPower | [out] | float64 * | This parameter returns the sum of powers of all the frequency bins over the integration bandwidth of the subblock. When you set the RFMXLTE_ATTR_ACP_POWER_UNITS attribute to dBm, the parameter returns the total subblock power in dBm of all the active carriers measured over the subblock. When you set the ACP Pwr Units attribute to dBm/Hz, the parameter returns the power spectral density in dBm/Hz based on the power in all the active carriers measured over the subblock. |
integrationBandwidth | [out] | float64 * | This parameter returns the integration bandwidth used in calculating the power of the subblock. Integration bandwidth is the span from left edge of the leftmost carrier to the right edge of the rightmost carrier within a subblock. This value is expressed in Hz. |
frequency | [out] | float64 * | This parameter returns the absolute center frequency of the subblock. This value is the center of the subblock integration bandwidth. 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 RFmxLTE_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |