Skip to content

NI RFmx LTE SEM Configuration Functions

Dane Stull edited this page Feb 28, 2022 · 2 revisions

SEM Configuration Functions

RFmxLTE_SEMCfgAveraging

int32 __stdcall RFmxLTE_SEMCfgAveraging (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 averagingEnabled, int32 averagingCount, int32 averagingType);

Purpose

Configures averaging for the SEM measurement.

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. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
averagingEnabled int32 Specifies whether to enable averaging for the measurement.
RFMXLTE_VAL_SEM_AVERAGING_ENABLED_FALSE (0) The measurement is performed on a single acquisition.
RFMXLTE_VAL_SEM_AVERAGING_ENABLED_TRUE (1) The measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the averagingCount parameter.
averagingCount int32 Specifies the number of acquisitions used for averaging when you set the averagingEnabled parameter to RFMXLTE_VAL_SEM_AVERAGING_ENABLED_TRUE.
averagingType int32 Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement.
RFMXLTE_VAL_SEM_AVERAGING_TYPE_RMS (0) The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.
RFMXLTE_VAL_SEM_AVERAGING_TYPE_LOG (1) The power spectrum is averaged in a logarithmic scale.
RFMXLTE_VAL_SEM_AVERAGING_TYPE_SCALAR (2) The square root of the power spectrum is averaged.
RFMXLTE_VAL_SEM_AVERAGING_TYPE_MAXIMUM (3) The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.
RFMXLTE_VAL_SEM_AVERAGING_TYPE_MINIMUM (4) The lowest power in the spectrum at each frequency bin is retained from one acquisition to the next.

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

RFmxLTE_SEMCfgSweepTime

int32 __stdcall RFmxLTE_SEMCfgSweepTime (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 sweepTimeAuto, float64 sweepTimeInterval);

Purpose

Configures the sweep time.

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. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
sweepTimeAuto int32 Specifies whether the measurement computes the sweep time.
RFMXLTE_VAL_SEM_SWEEP_TIME_AUTO_FALSE (0) The measurement uses the sweep time that you specify in the sweepTimeInterval parameter.
RFMXLTE_VAL_SEM_SWEEP_TIME_AUTO_TRUE (1) The measurement uses a sweep time of 1 ms.
sweepTimeInterval float64 Specifies the sweep time when you set the sweepTimeAuto parameter to RFMXLTE_VAL_SEM_SWEEP_TIME_AUTO_FALSE. This value is expressed in seconds.

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

RFmxLTE_SEMCfgUplinkMaskType

int32 __stdcall RFmxLTE_SEMCfgUplinkMaskType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 uplinkMaskType);

Purpose

Configures the standard defined mask type that has to be used in the measurement for uplink.

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. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
uplinkMaskType int32 Specifies the standard-defined spectrum emission mask used in the measurement for uplink. The following mask types are supported: general, NS_03orNS_11orNS_20orNS_21, NS_04, NS_06orNS_07, CA_NS_04, custom, generalCAClassB, CA_NC_NS_01, NS_27, and NS_35. Each mask type refers to a different Network Signalled (NS) value. CA_NS_04 and CA_NC_NS_01 refers to carrier aggregation case. You must set the mask type to CUSTOM to configure the custom offset masks. Refer to section 6.6.2.1 of the 3GPP 36.521 specification for more information about standard-defined mask types.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_GENERAL_NS01 (0) The measurement selects the offset frequencies and limits for the SEM as defined in Table 6.6.2.1.5-1, 6.6.2.1.5-2, 6.6.2.1A.5-1, and 6.6.2.1A.5-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_NS03_OR_NS11_OR_NS20_OR_NS21 (1) The measurement selects the offset frequencies and limits for the SEM as defined in Table 6.6.2.2.5.1-1 and 6.6.2.2.5.1-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_NS04 (2) The measurement selects the offset frequencies and limits for the SEM in Table 6.6.2.2.3.2-3 in section 6.6.2 of the 3GPP TS 36.521-1 specification.
When RFMXLTE_ATTR_COMPONENT_CARRIER_BANDWIDTH is 1.4 MHz or 3 MHz, the measurement selects the offset frequencies and limits for the SEM as defined in Table 6.6.2.2.5.2-1 in section 6.6.2 of the 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_NS06_OR_NS07 (3) The measurement selects the offset frequencies and limits for the SEM as defined in Table 6.6.2.2.5.3-1 and 6.6.2.2.5.3-2 in section 6.6.2 of the 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_CANS04 (4) The measurement selects the offset frequencies and limits for the SEM as defined in Table 6.6.2.2A.1.5.1-1 in section 6.6.2 of the 3GPP TS 36.521-1 specification. This mask applies only for aggregated carriers.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_CUSTOM (5) You need to configure the RFMXLTE_ATTR_SEM_NUMBER_OF_OFFSETS), RFMXLTE_ATTR_SEM_OFFSET_START_FREQUENCY), RFMXLTE_ATTR_SEM_OFFSET_STOP_FREQUENCY), RFMXLTE_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_START), RFMXLTE_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_STOP), RFMXLTE_ATTR_SEM_OFFSET_SIDEBAND), RFMXLTE_ATTR_SEM_OFFSET_RBW_FILTER_BANDWIDTH), RFMXLTE_ATTR_SEM_OFFSET_RBW_FILTER_TYPE), and RFMXLTE_ATTR_SEM_OFFSET_BANDWIDTH_INTEGRAL) attributes for each offset.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_GENERAL_CACLASSB (6) The measurement selects offset frequencies and limits for the SEM as defined in Table 6.6.2.1A.1.5-3 and 6.6.2.1A.1.5-4 in section 6.6.2 of 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_CANCNS01 (7) The measurement selects offset frequencies and limits for the SEM as defined in Table 6.6.2.2A.3.5-1 and 6.6.2.2A.3.5-2 in section 6.6.2 of 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_NS27 (8) The measurement selects offset frequencies and limits for the SEM as defined in Table 6.6.2.2.5.4-1 in section 6.6.2.2.5.4 of 3GPP TS 36.521-1 specification.
RFMXLTE_VAL_SEM_UPLINK_MASK_TYPE_NS35 (9) The measurement selects offset frequencies and limits for the SEM as defined in Table 6.6.2.2.5.5-1 in section 6.6.2.2.5.5 of 3GPP TS 36.521-1 specification.

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

RFmxLTE_SEMCfgDownlinkMask

int32 __stdcall RFmxLTE_SEMCfgDownlinkMask (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 downlinkMaskType, float64 deltaFMaximum, float64 aggregatedMaximumPower);

Purpose

Configures the downlinkMaskType, deltaF_max, and aggregatedMaximumOutputPower parameters for the SEM measurement in LTE downlink.

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. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
downlinkMaskType int32 Specifies the standard-defined spectrum emission mask used in the measurement for the downlink. You must set the mask type to CUSTOM to configure the custom offsets and the masks. Refer to section 6.6.3 of the 3GPP 36.141 specification for more information about standard-defined mask types.
RFMXLTE_VAL_SEM_DOWNLINK_MASK_TYPE_ENODEB_CATEGORY_BASED (0) Specifies limits are applied based on eNodeB Category attribute.
RFMXLTE_VAL_SEM_DOWNLINK_MASK_TYPE_BAND46 (1) Specifies that limits are applied based on Band 46 test requirements.
RFMXLTE_VAL_SEM_DOWNLINK_MASK_TYPE_CUSTOM (5) You need to configure the RFMXLTE_ATTR_SEM_NUMBER_OF_OFFSETS), RFMXLTE_ATTR_SEM_OFFSET_START_FREQUENCY), RFMXLTE_ATTR_SEM_OFFSET_STOP_FREQUENCY), RFMXLTE_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_START), RFMXLTE_ATTR_SEM_OFFSET_ABSOLUTE_LIMIT_STOP), SEM Offset Rel Limit Start, RFMXLTE_ATTR_SEM_OFFSET_RELATIVE_LIMIT_STOP), RFMXLTE_ATTR_SEM_OFFSET_SIDEBAND), RFMXLTE_ATTR_SEM_OFFSET_RBW_FILTER_BANDWIDTH), RFMXLTE_ATTR_SEM_OFFSET_RBW_FILTER_TYPE), and RFMXLTE_ATTR_SEM_OFFSET_BANDWIDTH_INTEGRAL) attributes for each offset.
deltaFMaximum float64 Specifies the stop frequency for the last offset segment to be used in the measurement. This value is expressed in Hz.
aggregatedMaximumPower float64 Specifies the aggregated maximum output power of all the transmit antenna connectors. This value is expressed in dBm.

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

RFmxLTE_SEMCfgComponentCarrierMaximumOutputPower

int32 __stdcall RFmxLTE_SEMCfgComponentCarrierMaximumOutputPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 componentCarrierMaximumOutputPower);

Purpose

Configures the maximum output power of the component carrier. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

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, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
componentCarrierMaximumOutputPower float64 Specifies the maximum output power per carrier, which is used only to choose the limit table for Medium Range Base Station. This value is expressed in dBm. Refer to the section 6.6.3 of the 3GPP 36.141 specification for more details.

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

RFmxLTE_SEMCfgNumberOfOffsets

int32 __stdcall RFmxLTE_SEMCfgNumberOfOffsets (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfOffsets);

Purpose

Configures the number of offset segments for the SEM measurement.

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, and subblock 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"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
numberOfOffsets int32 Specifies the number of SEM offset segments.

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

RFmxLTE_SEMCfgOffsetFrequency

int32 __stdcall RFmxLTE_SEMCfgOffsetFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetStartFrequency, float64 offsetStopFrequency, int32 offsetSideband);

Purpose

Configures the start and stop frequencies and the sideband of an offset segment. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to configure from this function.

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, subblock number, and offset number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
You can use the RFmxLTE_BuildOffsetString) function to build the selector string.
offsetStartFrequency float64 Specifies the start frequency of an offset segment relative to the carrier channel bandwidth edge (single-carrier) or the subblock aggregated channel bandwidth edge (multi-carrier). This value is expressed in Hz.
offsetStopFrequency float64 Specifies the stop frequency of an offset segment relative to the carrier channel bandwidth edge (single-carrier) or the subblock aggregated channel bandwidth edge (multi-carrier). This value is expressed in Hz.
offsetSideband int32 Specifies whether the offset segment is present on one side, or on both sides of the carrier.
RFMXLTE_VAL_SEM_OFFSET_SIDEBAND_NEGATIVE (0) Configures a lower offset segment to the left of the leftmost carrier.
RFMXLTE_VAL_SEM_OFFSET_SIDEBAND_POSITIVE (1) Configures an upper offset segment to the right of the rightmost carrier.
RFMXLTE_VAL_SEM_OFFSET_SIDEBAND_BOTH (2) Configures both the negative and the positive offset segments.

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

RFmxLTE_SEMCfgOffsetBandwidthIntegral

int32 __stdcall RFmxLTE_SEMCfgOffsetBandwidthIntegral (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetBandwidthIntegral);

Purpose

Configures the bandwidth integral of the offset segments. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to configure this function.

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, subblock number, and offset number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
You can use the RFmxLTE_BuildOffsetString) function to build the selector string.
offsetBandwidthIntegral int32 Specifies the resolution of the spectrum to compare with the spectral mask limits as an integer multiple of the RBW.
When you set this parameter to a value greater than 1, the measurement acquires the spectrum with a narrow resolution and then processes it digitally to get a wider resolution that is equal to the product of a bandwidth integral and a RBW.

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

RFmxLTE_SEMCfgOffsetRBWFilter

int32 __stdcall RFmxLTE_SEMCfgOffsetRBWFilter (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetRBW, int32 offsetRBWFilterType);

Purpose

Configures the offset RBW and the offset RBW filter type. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to configure this function.

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, subblock number, and offset number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
You can use the RFmxLTE_BuildOffsetString) function to build the selector string.
offsetRBW float64 Specifies the bandwidth of an RBW filter used to sweep an acquired offset segment. This value is expressed in Hz.
offsetRBWFilterType int32 Specifies the shape of the digital RBW filter.
RFMXLTE_VAL_SEM_OFFSET_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXLTE_VAL_SEM_OFFSET_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXLTE_VAL_SEM_OFFSET_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.

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

RFmxLTE_SEMCfgOffsetLimitFailMask

int32 __stdcall RFmxLTE_SEMCfgOffsetLimitFailMask (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 limitFailMask);

Purpose

Configures the limit fail mask of the offset segments that specify the criteria to determine the measurement fail status. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to configure this function.

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, subblock number, and offset number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
You can use the RFmxLTE_BuildOffsetString) function to build the selector string.
limitFailMask int32 Specifies the criteria to determine the measurement fail status.

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

RFmxLTE_SEMCfgOffsetAbsoluteLimit

int32 __stdcall RFmxLTE_SEMCfgOffsetAbsoluteLimit (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetAbsoluteLimitStart, float64 offsetAbsoluteLimitStop);

Purpose

Configures the start and the stop limit of an offset segment. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to configure this function.

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, subblock number, and offset number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
You can use the RFmxLTE_BuildOffsetString) function to build the selector string.
offsetAbsoluteLimitStart float64 Specifies the absolute power limit corresponding to the beginning of an offset segment. This value is expressed in dBm.
offsetAbsoluteLimitStop float64 Specifies the absolute power limit corresponding to the end of an offset segment. This value is expressed in dBm.

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

RFmxLTE_SEMCfgOffsetRelativeLimit

int32 __stdcall RFmxLTE_SEMCfgOffsetRelativeLimit (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 relativeLimitStart, float64 relativeLimitStop);

Purpose

Configures the start and stop relative limit of the offset segment. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function.

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, subblock number, and offset number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/offset0"
"signal::sig1/subblock0/offset0"
You can use the RFmxLTE_BuildOffsetString) function to build the selector string.
relativeLimitStart float64 Specifies the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB.
relativeLimitStop float64 Specifies the relative power limit corresponding to the end of the offset segment. 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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubblockString

int32 __stdcall RFmxLTE_BuildSubblockString (char selectorString[], int32 subblockNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subblock string to use as the selector string with the subblock configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the 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 RFmxLTE_BuildSignalString) function to build the selector string.
subblockNumber int32 Specifies the number of subblocks that are configured in the intra-band noncontiguous carrier aggregation. Set this parameter to 1, which is the default, for single carrier and intra-band contiguous carrier aggregation.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

RFmxLTE_BuildOffsetString

int32 __stdcall RFmxLTE_BuildOffsetString (char selectorString[], int32 offsetNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the offset string to use as the selector string with SEM and ACP offset configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the 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 RFmxLTE_BuildSignalString) function to build the selector string.
offsetNumber int32 Specifies the offset number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

SEM Array Configuration

RFmxLTE_SEMCfgComponentCarrierMaximumOutputPowerArray

int32 __stdcall RFmxLTE_SEMCfgComponentCarrierMaximumOutputPowerArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 componentCarrierMaximumOutputPower[], int32 numberOfElements);

Purpose

Configures the array of maximum output power of the component carrier. Use "subblock<n>" as the selector string to configure this function.

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 and the subblock number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0"
"signal::sig1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
componentCarrierMaximumOutputPower float64[] Specifies the array of maximum output power per carrier, which is used only to choose the limit table for Medium Range Base Station. This value is expressed in dBm. Refer to the section 6.6.3 of the 3GPP 36.141 specification for more details.
numberOfElements int32 Specifies the number of elements in each array.

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

RFmxLTE_SEMCfgOffsetFrequencyArray

int32 __stdcall RFmxLTE_SEMCfgOffsetFrequencyArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetStartFrequency[], float64 offsetStopFrequency[], int32 offsetSideband[], int32 numberOfElements);

Purpose

Configures the arrays of the start and stop frequencies and the sideband of an offset segment. Use "subblock<n>" as the selector string to configure this function.

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, and subblock 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"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
offsetStartFrequency float64[] Specifies the array of the start frequency values of the offset segment relative to the carrier channel bandwidth edge (single-carrier) or the subblock aggregated channel bandwidth edge (multi-carrier). This value is expressed in Hz.
offsetStopFrequency float64[] Specifies the array of the stop frequency values of the offset segment relative to the carrier channel bandwidth edge (single-carrier) or the subblock aggregated channel bandwidth edge (multi-carrier). This value is expressed in Hz.
offsetSideband int32[] Specifies whether the offset segment is present on one side, or on both sides of the carrier for each offset.
RFMXLTE_VAL_SEM_OFFSET_SIDEBAND_NEGATIVE (0) Configures a lower offset segment to the left of the leftmost carrier.
RFMXLTE_VAL_SEM_OFFSET_SIDEBAND_POSITIVE (1) Configures an upper offset segment to the right of the rightmost carrier.
RFMXLTE_VAL_SEM_OFFSET_SIDEBAND_BOTH (2) Configures both the negative and the positive offset segments.
numberOfElements int32 Specifies the number of elements in each array.

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

RFmxLTE_SEMCfgOffsetBandwidthIntegralArray

int32 __stdcall RFmxLTE_SEMCfgOffsetBandwidthIntegralArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 offsetBandwidthIntegral[], int32 numberOfElements);

Purpose

Configures the array of the bandwidth integral of the offset segments. Use "subblock<n>" as the selector string to configure this function.

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, and subblock 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"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
offsetBandwidthIntegral int32[] Specifies the array of the resolution values of the spectrum to compare with the spectral mask limits as an integer multiple of the RBW.
When you set this parameter to a value greater than 1, the measurement acquires the spectrum with a narrow resolution and then processes it digitally to get a wider resolution that is equal to the product of a bandwidth integral and an RBW.
numberOfElements int32 Specifies the number of elements in each array.

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

RFmxLTE_SEMCfgOffsetRBWFilterArray

int32 __stdcall RFmxLTE_SEMCfgOffsetRBWFilterArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetRBW[], int32 offsetRBWFilterType[], int32 numberOfElements);

Purpose

Configures the offset RBW and the offset RBW filter type arrays. Use "subblock<n>" as the selector string to configure from this function.

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, and subblock 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"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
offsetRBW float64[] Specifies the array of the RBW filter bandwidth values used to sweep the acquired offset segment, when you set the SEM Offset RBW Auto attribute to False. This value is expressed in Hz.
offsetRBWFilterType int32[] Specifies the array of the shape of a digital RBW filter.
RFMXLTE_VAL_SEM_OFFSET_RBW_FILTER_TYPE_FFT_BASED (0) No RBW filtering is performed.
RFMXLTE_VAL_SEM_OFFSET_RBW_FILTER_TYPE_GAUSSIAN (1) The RBW filter has a Gaussian response.
RFMXLTE_VAL_SEM_OFFSET_RBW_FILTER_TYPE_FLAT (2) The RBW filter has a flat response.
numberOfElements int32 Specifies the number of elements in each array.

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

RFmxLTE_SEMCfgOffsetLimitFailMaskArray

int32 __stdcall RFmxLTE_SEMCfgOffsetLimitFailMaskArray (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 limitFailMask[], int32 numberOfElements);

Purpose

Configures the array of limit fail mask of the offset segments that specifies the criteria to determine the measurement fail status. Use "subblock<n>" as the selector string to read results from this function.

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, and subblock 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"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
limitFailMask int32[] Specifies the array of criterion to determine the measurement fail status.
numberOfElements int32 Specifies the number of elements in each array.

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

RFmxLTE_SEMCfgOffsetAbsoluteLimitArray

int32 __stdcall RFmxLTE_SEMCfgOffsetAbsoluteLimitArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 offsetAbsoluteLimitStart[], float64 offsetAbsoluteLimitStop[], int32 numberOfElements);

Purpose

Configures the array of the start limit and the stop limit of the offset segments. Use "subblock<n>" as the selector string to configure this function.

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 and the subblock number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0"
"signal::sig1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
offsetAbsoluteLimitStart float64[] Specifies the array of the absolute power limits corresponding to the beginning of an offset segment. This value is expressed in dBm.
offsetAbsoluteLimitStop float64[] Specifies the array of the absolute power limits corresponding to the end of an offset segment. This value is expressed in dBm.
numberOfElements int32 Specifies the number of elements in each array.

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

RFmxLTE_SEMCfgOffsetRelativeLimitArray

int32 __stdcall RFmxLTE_SEMCfgOffsetRelativeLimitArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 relativeLimitStart[], float64 relativeLimitStop[], int32 numberOfElements);

Purpose

Configures the array of start and stop relative limits of the offset segments. Use "subblock<n>" as the selector string to read results from this function.

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, and subblock 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"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
relativeLimitStart float64[] Specifies the array of relative power limits corresponding to the beginning of the offset segment. This value is expressed in dB.
relativeLimitStop float64[] Specifies the array of relative power limits corresponding to the end of the offset segment. This value is expressed in dB.
numberOfElements int32 Specifies the number of elements in each array.

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

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally