RFmxNR_SEMFetchUpperOffsetPowerArray
- Updated2025-04-08
- 2 minute(s) read
Returns an array of total absolute and relative powers, peak, absolute, and relative powers, and frequencies at peak absolute powers of upper offset segments. The relative power is relative to total aggregated power.
Use "subblock<n>" as the selector string to read results from this function.
Syntax
int32 __stdcall RFmxNR_SEMFetchUpperOffsetPowerArray(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 totalAbsolutePower[], float64 totalRelativePower[], float64 peakAbsolutePower[], float64 peakFrequency[], float64 peakRelativePower[], int32 arraySize, int32 *actualArraySize)
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 "" (empty 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. |
totalAbsolutePower | [out] | float64 | This parameter returns an array of the upper segment power. This value is expressed in dBm. |
totalRelativePower | [out] | float64 | This parameter returns an array of the power in the upper offset segment relative to total aggregated power. This value is expressed in dB. |
peakAbsolutePower | [out] | float64 | This parameter returns an array of the peak power in the upper offset segment. This value is expressed in dBm. |
peakFrequency | [out] | float64 | This parameter returns an array of the frequency at which the peak power occurs in the upper offset segment. This value is expressed in Hz. |
peakRelativePower | [out] | float64 | This parameter returns an array of the peak power in the upper offset segment relative to total aggregated power. This value is expressed in dB. |
arraySize | [in] | 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. |
actualArraySize | [out] | int32 * | Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0. |
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 |