RFmx LTE CVI

RFmxLTE_SEMFetchUpperOffsetMargin

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

RFmxLTE_SEMFetchUpperOffsetMargin

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

Purpose

Returns the measurement status, margin, frequency at margin, and absolute and relative powers at margin for upper offset segments. The relative power is relative to total aggregated power.
Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function.
Refer to the LTE Uplink Spectral Emission Mask and LTE Downlink Spectral Emission Mask topics for more information.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name, result name, subblock number, 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.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
"signal::sig1/result::r1/subblock0/offset0"
"result::r1/subblock0/offset0"
You can use the RFmxLTE_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* Returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.
RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) Indicates that the measurement has failed.
RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_PASS (1) Indicates that the measurement has passed.
margin float64* Returns the margin from the standard defined absolute limit mask for upper offset. Margin is defined as the minimum difference between the spectrum and the limit mask. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned.
marginFrequency float64* Returns the frequency at which the margin occurs in the upper offset. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned.
marginAbsolutePower float64* Returns the power at which the margin occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned.
marginRelativePower float64* Returns the power at which the margin occurs in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned.

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 RFmxLTE_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors