RFmxCDMA2k_SEMFetchUpperOffsetMargin
- Updated2024-10-14
- 2 minute(s) read
RFmxCDMA2k_SEMFetchUpperOffsetMargin
int32 __stdcall RFmxCDMA2k_SEMFetchUpperOffsetMargin (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus, float64* margin, float64* marginFrequency, float64* marginAbsolutePower, float64* marginRelativePower);
Purpose
Returns the measurement status and margin from the limit line measured in the upper offset segment.
Use "offset<n>" as the selector string to read parameters from this function.
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, result name, and offset 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. Examples: "offset0" "signal::sig1/offset0" "result::r1/offset0" "signal::sig1/result::r1/offset0" You can use the RFmxCDMA2k_BuildOffsetString 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. | ||||
| Output | ||||||
| Name | Type | Description | ||||
| measurementStatus | int32* | Indicates the upper offset measurement status based on measurement limits and the failure criteria specified by the standard.
|
||||
| margin | float64* | Returns the margin from the limit mask value specified by the standard. This value is expressed in dB. Margin is defined as the minimum difference between the spectrum and the closest limit mask (absolute or relative). |
||||
| marginFrequency | float64* | Returns the frequency at which the margin occurred in the upper (positive) offset. This value is expressed in Hz. |
||||
| marginAbsolutePower | float64* | Returns the power at which the margin occurred in the upper (positive) offset segment. This value is expressed in dBm. |
||||
| marginRelativePower | float64* | Returns the power at which the margin occurred in the upper (positive) offset segment relative to the carrier absolute integrated power. This value is expressed in dB. |
||||
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:
|
||||||||