RFmx CDMA2K CVI

RFmxCDMA2k_SEMFetchUpperOffsetPowerArray

  • Updated2024-10-14
  • 2 minute(s) read

RFmxCDMA2k_SEMFetchUpperOffsetPowerArray

int32 __stdcall RFmxCDMA2k_SEMFetchUpperOffsetPowerArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 absoluteIntegratedPower[], float64 relativeIntegratedPower[], float64 absolutePeakPower[], float64 peakFrequency[], float64 relativePeakPower[], int32 arraySize, int32* actualArraySize);

Purpose

Returns the arrays of upper offset segment power measurements.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxCDMA2k_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.
Examples:
""
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxCDMA2k_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
absoluteIntegratedPower float64[] Returns the array of upper (positive) offset segment powers measured.
relativeIntegratedPower float64[] Returns the array of powers measured in each upper (positive) offset segment relative to the carrier absolute integrated power.
absolutePeakPower float64[] Returns the array of peak powers measured in each upper (positive) offset segment. The power is measured in dBm.
peakFrequency float64[] Returns the array of frequencies at which the peak power occurred in each offset segment. This value is expressed in Hz.
relativePeakPower float64[] Returns the array of peak powers measured in each upper (positive) offset segment relative to the carrier absolute integrated power.
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 RFmxCDMA2k_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors