RFmxTDSCDMA_SEMFetchUpperOffsetMarginArray
- Updated2024-10-14
- 2 minute(s) read
RFmxTDSCDMA_SEMFetchUpperOffsetMarginArray
int32 __stdcall RFmxTDSCDMA_SEMFetchUpperOffsetMarginArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 measurementStatus[], float64 margin[], float64 marginFrequency[], float64 marginAbsolutePower[], float64 marginRelativePower[], int32 arraySize, int32* actualArraySize);
Purpose
Returns the measurement status and margin from the limit line measured in the upper offset segments.
Parameters
| Input | ||||||
| Name | Type | Description | ||||
| instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxTDSCDMA_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 RFmxTDSCDMA_BuildSignalString function to build the selector string. |
||||
| timeout | float64 | 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. |
||||
| 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 | ||||
| measurementStatus | int32[] | Returns the array of upper offset measurement statuses based on measurement limits and the failure criteria specified by the standard.
|
||||
| margin | float64[] | Returns the array of margins from the limit mask value specified by the standard. This value is expressed in dB. The margin is defined as the minimum distance between the spectrum and the limit mask. |
||||
| marginFrequency | float64[] | Returns the array of frequencies at which the margin occurs in each positive offset. This value is expressed in Hz. |
||||
| marginAbsolutePower | float64[] | Returns the array of powers at which the margin occurs in each positive offset segment. This value is expressed in dBm. |
||||
| marginRelativePower | float64[] | Returns the array of powers at which the margin occurs in each positive offset segment relative to the integrated power of the reference carrier. This value is expressed in dB. |
||||
| 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 RFmxTDSCDMA_GetError function. The general meaning of the status code is as follows:
|
||||||||