RFmxWLAN_OFDMModAccFetchCommonPilotErrorTrace
- Updated2024-10-14
- 2 minute(s) read
RFmxWLAN_OFDMModAccFetchCommonPilotErrorTrace
int32 __stdcall RFmxWLAN_OFDMModAccFetchCommonPilotErrorTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 commonPilotErrorMagnitude[], float32 commonPilotErrorPhase[], int32 arraySize, int32* actualArraySize);
Purpose
Fetches the common pilot error magnitude and phase traces.
Use "segment<n>" as the selector string to read results from this function.
Parameters
| Input | ||
| Name | Type | Description |
| instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
| selectorString | char[] | Specifies a selector string comprising of the signal name, result name, and segment number. If you do not specify the signal name, the default signal instance is used. Example: "segment0" "signal::sig1/segment0" "result::r1/segment0" "signal::sig1/result::r1/segment0" You can use the RFmxWLAN_BuildSegmentString 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 |
| x0 | float64* | Returns the starting OFDM symbol index corresponding to the value of
RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute.
|
| dx | float64* | Returns the OFDM symbol increment value. This value is always equal to 1.
|
| commonPilotErrorMagnitude | float32[] | Returns an array of magnitude of the common pilot error for each OFDM symbol. This value is expressed in dB.
|
| commonPilotErrorPhase | float32[] | Returns an array of phase of the common pilot error for each OFDM symbol. This value is expressed in degrees.
|
| 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows:
|
||||||||