RFmx WCDMA C

Table of Contents

RFmxWCDMA_SEMFetchLowerOffsetMarginArray

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

RFmxWCDMA_SEMFetchLowerOffsetMarginArray

int32 __stdcall RFmxWCDMA_SEMFetchLowerOffsetMarginArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 measurementStatus[], float64 margin[], float64 marginFrequency[], float64 marginAbsolutePower[], float64 marginRelativePower[], int32 arraySize, int32* actualArraySize);

Purpose

Fetches an array of measurement status values, an array of margins, an array of frequencies at the margins, an array of the absolute powers, and an array of the relative powers at the margin frequencies for lower offset segments for the SEM measurement. The relative power is relative to the total carrier power.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWCDMA_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.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxWCDMA_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
measurementStatus int32[] Indicates an array of measurement status values based on the values of the SEM Results Lower Offset Margin attribute corresponding to each lower offset segment.
margin float64[] Returns an array of margins of the lower offset segments. This value is expressed in dB.
In a single carrier SEM, the maximum of the absolute spectrum trace with reference to the standard-defined absolute mask limit in the lower offset segment is measured. The maximum of the relative spectrum trace with reference to the standard-defined relative mask limit, in the lower offset segment is also measured. The higher value is the margin.
In a multicarrier SEM, the maximum of the absolute spectrum trace with reference to the standard-defined absolute mask limit in the lower offset segment is the margin.
marginFrequency float64[] Returns an array of frequencies at which the margins occurred in the lower, or negative, offset segments This value is expressed in Hz.
marginAbsolutePower float64[] Returns an array of powers at which the margins occurred in the lower, or negative, offset segment.
This value is expressed in dBm.
marginRelativePower float64[] Returns an array of powers at which the margins occurred in the lower, or negative, offset segments relative to the RFMXWCDMA_ATTR_SEM_RESULTS_TOTAL_CARRIER_POWER attribute. 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 RFmxWCDMA_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience