LTE

Defines a root class which is used to identify and control Lte signal configuration.

class nirfmxlte.lte.Lte(session, signal_name='', cloning=False)[source]

Bases: _LteBase

Defines a root class which is used to identify and control Lte signal configuration.

abort_measurements(selector_string)

Stops acquisition and measurements associated with signal instance that you specify in the Selector String parameter, which were previously initiated by the initiate() method or measurement read methods. Calling this method is optional, unless you want to stop a measurement before it is complete. This method executes even if there is an incoming error.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

analyze_iq_1_waveform(selector_string, result_name, x0, dx, iq, reset)

Performs the enabled measurements on the I/Q complex waveform that you specify in the IQ parameter. Call this method after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch methods or result attributes in the attribute node. Use this method only if the RECOMMENDED_ACQUISITION_TYPE attribute value is either IQ or IQ or Spectral. When using the Analysis-Only mode in RFmxLTE, the RFmx driver ignores the RFmx hardware settings such as reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and trigger type, since it is needed for spectral measurement traces as well as some measurements such as ModAcc, ACP, and SEM.

Note

Query the Recommended Acquisition Type attribute from the RFmxInstr Attribute after calling the commit() method.

Parameters:

selector_string (string) –
This parameter specifies the result name. The result name can either be specified through this input or the Result Name parameter. If you do not specify the result name in this parameter, either the result name specified by the Result Name parameter or the default result instance is used.

Example:

””

”result::r1”

You can use the build_result_string() method to build the Selector String.
result_name (string) –
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as “r1” to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the “result::” prefix. The default value is “” (empty string), which refers to the default result instance.

Example:

””

”result::r1”

”r1”
x0 (float) – This parameter specifies the start time of the input y array. This value is expressed in seconds.
dx (float) – This parameter specifies the time interval between the samples in the input y array. This value is expressed in seconds. The reciprocal of dx indicates the I/Q rate of the input signal.
iq (numpy.complex64) – This parameter specifies an array of complex-valued time domain data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.
reset (bool) – This parameter resets measurement averaging. If you enable averaging, set this parameter to TRUE for the first record and FALSE for the subsequent records.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

analyze_spectrum_1_waveform(selector_string, result_name, x0, dx, spectrum, reset)

Performs the enabled measurements on the spectrum that you specify in the Spectrum parameter. Call this method after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch methods or result attributes in the attribute node. Use this method only if the RECOMMENDED_ACQUISITION_TYPE attribute value is either Spectral or IQ or Spectral.

Note

Query the Recommended Acquisition Type attribute from the RFmxInstr Attribute after calling the commit() method.

Parameters:

selector_string (string) –
This parameter specifies the result name. The result name can either be specified through this input or the Result Name parameter. If you do not specify the result name in this parameter, either the result name specified by the Result Name parameter or the default result instance is used.

Example:

””

”result::r1”

You can use the build_result_string() method to build the Selector String.
result_name (string) –
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as “r1” to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the “result::” prefix. The default value is “” (empty string), which refers to the default result instance.

Example:

””

”result::r1”

”r1”
x0 (float) – This parameter specifies the start frequency of the spectrum. This value is expressed in Hz.
dx (float) – This parameter specifies the frequency interval between data points in the spectrum.
spectrum (numpy.float32) – This parameter specifies the data for a spectrum waveform.
reset (bool) – This parameter resets measurement averaging. If you enable averaging, set this parameter to TRUE for the first record and FALSE for the subsequent records.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

auto_level(selector_string, measurement_interval)

Examines the input signal to calculate the peak power level and sets it as the value of the REFERENCE_LEVEL attribute. Use this method to calculate an approximate setting for the reference level.

RFmxLTE Auto Level method completes the following tasks: #. Resets the mixer level, mixer level offset, and IF output power offset.

Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation, and preamplifier enabled settings.
Iterates to adjust the reference level based on the input signal peak power.
Uses immediate triggering and restores the trigger settings back to user setting after the execution.

You can also specify the starting reference level using AUTO_LEVEL_INITIAL_REFERENCE_LEVEL attribute.

When using PXIe-5663, PXIe-5665, or PXIe-5668 devices, NI recommends that you set an appropriate value for mechanical attenuation before calling RFmxLTE Auto Level method. Setting an appropriate value for mechanical attenuation reduces the number of times the attenuator settings are changed by this function; thus reducing wear and tear, and maximizing the life time of the attenuator.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_interval (float) –
This parameter specifies the acquisition length. This value is expressed in seconds. Use this value to compute the number of samples to acquire from the signal analyzer. The default value is 10 ms.

Auto Level method does not use any trigger for acquisition. It ignores the user-configured trigger attributes. NI recommends that you set a sufficiently high measurement interval to ensure that the acquired waveform is at least as long as one period of the signal.

Returns:

reference_level (float):: This parameter returns the estimated peak power level of the input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices. The default value of this parameter is hardware dependent.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (reference_level, error_code)

static build_carrier_string(selector_string, carrier_number)

Creates a carrier string to use as a selector string with the SEM and ACP carrier configurations or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
carrier_number (int) – This parameter specifies the carrier number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_cluster_string(selector_string, cluster_number)

Creates a cluster string to use as a selector string with the ModAcc cluster configuration or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
cluster_number (int) – This parameter specifies the cluster number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_offset_string(selector_string, offset_number)

Creates an offset string to use as a selector string with SEM and ACP offset configuration or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
offset_number (int) – This parameter specifies the offset number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_pdsch_string(selector_string, pdsch_number)

Creates a PDSCH string to use as a selector string with the configuration or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
pdsch_number (int) – This parameter specifies the PDSCH channel number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_result_string(result_name)

Creates selector string for use with configuration or fetch.

Parameters:: result_name (string) – Specifies the result name for building the selector string. This input accepts the result name with or without the “result::” prefix. Example: “”, “result::r1”, “r1”.
Returns:: Contains the selector string created by this method.
Return type:: string

static build_subblock_string(selector_string, subblock_number)

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

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
subblock_number (int) – This parameter 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.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_subframe_string(selector_string, subframe_number)

Creates a subframe string to use as a selector string with the configuration or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
subframe_number (int) – This parameter specifies the subframe number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

check_measurement_status(selector_string)

Checks the status of the measurement. Use this method to check for any errors that may occur during measurement or to check whether the measurement is complete and results are available.

Parameters:

selector_string (string) –

This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.

Returns:

is_done (bool):: This parameter indicates whether the measurement is complete.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (is_done, error_code)

clear_all_named_results(selector_string)

Clears all results for the signal that you specify in the Selector String parameter.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

clear_named_result(selector_string)

Clears a result instance specified by the result name in the Selector String parameter.

Parameters:

selector_string (string) –

This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

clone_signal_configuration(new_signal_name)

Creates a new instance of a signal by copying all the properties from an existing signal instance.

Parameters:

new_signal_name (string) –

This parameter specifies the name of the new signal. This parameter accepts the signal name with or without the "signal::" prefix.

Example:

"signal::NewSigName"

"NewSigName"

Returns:

cloned_signal (lte):: Contains a new Lte signal instance.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (cloned_signal, error_code)

commit(selector_string)

Commits settings to the hardware. Calling this method is optional. RFmxLTE commits settings to the hardware when you call the initiate() method.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

configure_auto_dmrs_detection_enabled(selector_string, auto_dmrs_detection_enabled)

Configures whether the demodulation reference signal (DMRS) parameters are configured by a user or automatically detected by a measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

auto_dmrs_detection_enabled (enums.AutoDmrsDetectionEnabled, int) –

This parameter specifies whether you need to configure the DMRS parameters, such as the values of the UPLINK_GROUP_HOPPING_ENABLED, UPLINK_SEQUENCE_HOPPING_ENABLED, CELL_ID, PUSCH_N_DMRS_1, PUSCH_N_DMRS_2, and PUSCH_N_DMRS_2 properties, or if the measurement should automatically detect the values of these attributes. The default value is False.

Name (Value)	Description
False (0)	The user-defined DMRS parameters are used.
True (1)	The DMRS parameters are automatically detected. Measurements returns an error if you set the ModAcc Sync Mode attribute to Frame because it is not possible to get the frame boundary when RFmx automatically detects the DMRS parameters.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_band(selector_string, band)

Configures the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock.

Use “subblock<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

Example:

”subblock0”

You can use the build_subblock_string() method to build the selector string.
band (int) – This parameter specifies the E-UTRA operating frequency band of a subblock as defined in section 5.2 of the 3GPP TS 36.521 specification. Valid values are from 1 to 256, inclusive. The default value is 1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_digital_edge_trigger(selector_string, digital_edge_source, digital_edge, trigger_delay, enable_trigger)

Configures the device to wait for a digital edge trigger and then marks a reference point within the record.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

digital_edge_source (string) –

This parameter specifies the source terminal for the digital edge trigger. This parameter is used when you set the TRIGGER_TYPE attribute to Digital Edge. The default value of this parameter is hardware dependent.

Name (Value)	Description
PFI0 (PFI0)	The trigger is received on PFI 0.
PFI1 (PFI1)	The trigger is received on PFI 1.
PXI_Trig0 (PXI_Trig0)	The trigger is received on PXI trigger line 0.
PXI_Trig1 (PXI_Trig1)	The trigger is received on PXI trigger line 1.
PXI_Trig2 (PXI_Trig2)	The trigger is received on PXI trigger line 2.
PXI_Trig3 (PXI_Trig3)	The trigger is received on PXI trigger line 3.
PXI_Trig4 (PXI_Trig4)	The trigger is received on PXI trigger line 4.
PXI_Trig5 (PXI_Trig5)	The trigger is received on PXI trigger line 5.
PXI_Trig6 (PXI_Trig6)	The trigger is received on PXI trigger line 6.
PXI_Trig7 (PXI_Trig7)	The trigger is received on PXI trigger line 7.
PXI_STAR (PXI_STAR)	The trigger is received on the PXI star trigger line.
PXIe_DStarB (PXIe_DStarB)	The trigger is received on the PXIe DStar B trigger line.
TimerEvent (TimerEvent)	The trigger is received from the Timer Event.

digital_edge (enums.DigitalEdgeTriggerEdge, int) –
This parameter specifies the source terminal for the digital edge trigger. This parameter is used when you set the TRIGGER_TYPE attribute to Digital Edge. The default value is Rising Edge.

Name (Value)

Description

Rising Edge (0)

The trigger asserts on the rising edge of the signal.

Falling Edge (1)

The trigger asserts on the falling edge of the signal.
trigger_delay (float) – This parameter specifies the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. The default value is 0.
enable_trigger (bool) – This parameter specifies whether to enable the trigger. The default value is TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_duplex_scheme(selector_string, duplex_scheme, uplink_downlink_configuration)

Configures the duplexing technique of the signal being measured.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

duplex_scheme (enums.DuplexScheme, int) –

This parameter specifies the duplexing technique of the signal being measured. The default value is FDD.

Name (Value)	Description
FDD (0)	Specifies that the duplexing technique is frequency-division duplexing.
TDD (1)	Specifies that the duplexing technique is time-division duplexing.
LAA (2)	Specifies that the duplexing technique is license assisted access.

uplink_downlink_configuration (enums.UplinkDownlinkConfiguration, int) –

This parameter specifies the configuration of the LTE frame structure in the time division duplex (TDD) mode. To configure the LTE frame, refer to table 4.2-2 of the 3GPP TS 36.211 specification.

The default value is 0.

Name (Value)	Description
0 (0)	The configuration of the LTE frame structure in the TDD duplex mode is 0.
1 (1)	The configuration of the LTE frame structure in the TDD duplex mode is 1.
2 (2)	The configuration of the LTE frame structure in the TDD duplex mode is 2.
3 (3)	The configuration of the LTE frame structure in the TDD duplex mode is 3.
4 (4)	The configuration of the LTE frame structure in the TDD duplex mode is 4.
5 (5)	The configuration of the LTE frame structure in the TDD duplex mode is 5.
6 (6)	The configuration of the LTE frame structure in the TDD duplex mode is 6.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_enodeb_category(selector_string, enodeb_category)

Configures the eNodeB category of the signal being measured.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

enodeb_category (enums.eNodeBCategory, int) –

This parameter specifies the downlink eNodeB (Base Station) category. The default value is Wide Area Base Station - Category A (0).

Name (Value)	Description
Wide Area Base Station - Category A (0)	Specifies the eNodeB is Wide Area Base Station - Category A.
Wide Area Base Station - Category B Option1 (1)	Specifies the eNodeB is Wide Area Base Station - Category B Option1.
Wide Area Base Station - Category B Option2 (2)	Specifies the eNodeB is Wide Area Base Station - Category B Option2.
Local Area Base Station (3)	Specifies the eNodeB is Local Area Base Station.
Home Base Station (4)	Specifies the eNodeB is Home Base Station.
Medium Range Base Station (5)	Specifies the eNodeB is Medium Range Base Station.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_external_attenuation(selector_string, external_attenuation)

Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
external_attenuation (float) – This parameter specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the* NI RF Vector Signal Analyzers Help*. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency(selector_string, center_frequency)

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
center_frequency (float) – This parameter specifies the center frequency of the acquired RF signal for a single carrier. The parameter specifies the reference frequency of the subblock for intra-band carrier aggregation. The default value of this parameter is hardware dependent.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency_earfcn(selector_string, link_direction, band, earfcn)

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to the E-UTRA absolute radio frequency channel number (EARFCN) frequency.

Use “subblock<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

Example:

”subblock0”

You can use the build_subblock_string() method to build the selector string.

link_direction (enums.LinkDirection, int) –

This parameter specifies the link direction of the received signal. The default value is Uplink.

Name (Value)	Description
Downlink (0)	The measurement uses 3GPP LTE downlink specification to measure the received signal.
Uplink (1)	The measurement uses 3GPP LTE uplink specification to measure the received signal.

band (int) – This parameter specifies the E-UTRA operating frequency band of a subblock as defined in section 5.2 of the 3GPP TS 36.521 specification. Valid values are from 1 to 256, inclusive. The default value is 1.
earfcn (int) – This parameter specifies the evolved universal terrestrial radio access (E-UTRA) absolute radio frequency channel number. The default value is 18100.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_iq_power_edge_trigger(selector_string, iq_power_edge_source, iq_power_edge_slope, iq_power_edge_level, trigger_delay, trigger_min_quiet_time_mode, trigger_min_quiet_time_duration, iq_power_edge_level_type, enable_trigger)

Configures the device to wait for the complex power of the I/Q data to cross the specified threshold and then marks a reference point within the record.

To trigger on bursty signals, specify a minimum quiet time, which ensures that the trigger does not occur in the middle of the burst signal. The quiet time must be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
iq_power_edge_source (string) – This parameter specifies the channel from which the device monitors the trigger. This parameter is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge. The default value of this parameter is hardware dependent.
iq_power_edge_slope (enums.IQPowerEdgeTriggerSlope, int) –
This parameter specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. This parameter is used only when you set the Trigger Type attribute to IQ Power Edge. The default value is Rising Slope.

Name (Value)

Description

Rising Slope (0)

The trigger asserts when the signal power is rising.

Falling Slope (1)

The trigger asserts when the signal power is falling.
iq_power_edge_level (float) – This parameter specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ Power Edge Level Type parameter to Relative, and this value is expressed in dBm when you set the IQ Power Edge Level Type parameter to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this parameter, taking into consideration the specified slope. This parameter is used only when you set the Trigger Type attribute to IQ Power Edge. The default value of this parameter is hardware dependent.
trigger_delay (float) – This parameter specifies the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. The default value is 0.

trigger_min_quiet_time_mode (enums.TriggerMinimumQuietTimeMode, int) –

This parameter specifies whether the measurement computes the minimum quiet time used for triggering. The default value is Auto.

Name (Value)	Description
Manual (0)	The minimum quiet time for triggering is the value of the Min Quiet Time parameter.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

trigger_min_quiet_time_duration (float) –
This parameter specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds. If you set the IQ Power Edge Slope parameter to Rising Slope, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope parameter to Falling Slope, the signal is quiet above the trigger level.

The default value of this parameter is hardware dependent.

iq_power_edge_level_type (enums.IQPowerEdgeTriggerLevelType, int) –

This parameter specifies the reference for the** IQ Power Edge Level** parameter. The IQ Power Edge Level Type parameter is used only when you set the Trigger Type attribute to IQ Power Edge.

Name (Value)	Description
Relative (0)	The IQ Power Edge Level attribute is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level attribute specifies the absolute power.

enable_trigger (bool) – This parameter specifies whether to enable the trigger. The default value is TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_link_direction(selector_string, link_direction)

Configures the link direction of the signal being measured.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

link_direction (enums.LinkDirection, int) –

This parameter specifies the link direction of the received signal. The default value is Uplink.

Name (Value)	Description
Downlink (0)	The measurement uses 3GPP LTE downlink specification to measure the received signal.
Uplink (1)	The measurement uses 3GPP LTE uplink specification to measure the received signal.
Sidelink (2)	The measurement uses 3GPP LTE sidelink specifications to measure the received signal.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_number_of_component_carriers(selector_string, number_of_component_carriers)

Configures the number of component carriers within a subblock.

Use “subblock<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

Example:

”subblock0”

You can use the build_subblock_string() method to build the selector string.
number_of_component_carriers (int) – This parameter specifies the number of component carriers configured within a subblock. The default value is 1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_number_of_dut_antennas(selector_string, number_of_dut_antennas)

Configures the number of physical antennas used for transmission by the DUT in a MIMO setup.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_dut_antennas (int) – This parameter specifies the number of physical antennas available at the DUT for transmission in a MIMO setup. The default value is 1. Valid values are 1, 2, and 4.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_number_of_subblocks(selector_string, number_of_subblocks)

Configures the number of subblocks.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_subblocks (int) – This parameter specifies the number of subblocks that are configured in the intra-band noncontiguous carrier aggregation. The default value is 1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_reference_level(selector_string, reference_level)

Configures the reference level, which represents the maximum expected power of an RF input signal.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
reference_level (float) – This parameter specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices. The default value of this parameter is hardware dependent.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_rf(selector_string, center_frequency, reference_level, external_attenuation)

Configures the RF attributes of the signal specified by the selector string.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
center_frequency (float) – This parameter specifies the center frequency of the acquired RF signal for a single carrier. The parameter specifies the reference frequency of the subblock for intra-band carrier aggregation. The default value of this parameter is hardware dependent.
reference_level (float) – This parameter specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices. The default value of this parameter is hardware dependent.
external_attenuation (float) – This parameter specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the* NI RF Vector Signal Analyzers Help*. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_software_edge_trigger(selector_string, trigger_delay, enable_trigger)

Configures the device to wait for a software trigger and then marks a reference point within the record.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
trigger_delay (float) – This parameter specifies the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples. The default value is 0.
enable_trigger (bool) – This parameter specifies whether to enable the trigger. The default value is TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_transmit_antenna_to_analyze(selector_string, transmit_antenna_to_analyze)

Configures the current physical antenna of the DUT in the MIMO setup being tested.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
transmit_antenna_to_analyze (int) – This parameter specifies the physical antenna connected to the analyzer. The default value is 0. Valid values are from 0 to N-1, where N is the number of DUT antennas.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

delete_signal_configuration()

Deletes the current instance of a signal.

Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: error_code

disable_trigger(selector_string)

Configures the device to not wait for a trigger to mark a reference point within a record. This method defines the signal triggering as immediate.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

dispose(): Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any.

Note

You can call this function safely more than once, even if the signal is already deleted.

get_acquisition_bandwidth_optimization_enabled(selector_string)

Gets whether RFmx optimizes the acquisition bandwidth. This may cause acquisition center frequency or local oscillator (LO) to be placed at different position than you configured.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Refer to the Acquisition Bandwidth Optimization Enabled topic for more information.

The default value is True.

Name (Value)	Description
False (0)	RFmx does not optimize acquisition bandwidth and will be based on the Nyquist criterion. The value of the acquisition center frequency is the same as the value of the Center Frequency that you configure.
True (1)	RFmx positions the acquisition center frequency to acquire the least bandwidth based on the configuration and span needed for the measurement. This helps in reducing the amount of data to process for the measurement, thus improving the speed. However this might cause the LO to be positioned at a non-dc subcarrier position, hence the measurement sensitive to it should have this attribute disabled.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcquisitionBandwidthOptimizationEnabled):: Specifies whether RFmx optimizes the acquisition bandwidth. This may cause acquisition center frequency or local oscillator (LO) to be placed at different position than you configured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_all_named_result_names(selector_string)

Returns all the named result names of the signal that you specify in the Selector String parameter.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

Returns:

result_names (string):: Returns an array of result names.
default_result_exists (bool):: Indicates whether the default result exists.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (result_names, default_result_exists, error_code)

get_auto_dmrs_detection_enabled(selector_string)

Gets whether you configure the values of the demodulation reference signal (DMRS) parameters, such as UPLINK_GROUP_HOPPING_ENABLED, UPLINK_SEQUENCE_HOPPING_ENABLED, CELL_ID, PUSCH_N_DMRS_1, PUSCH_N_DMRS_2, and PUSCH_DELTA_SEQUENCE_SHIFT properties, or if the values of these attributes are auto-detected by the measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The user-specified DMRS parameters are used.
True (1)	The values of the DMRS parameters are automatically detected. Measurement returns an error if you set the ModAcc Sync Mode attribute to Frame, since it is not possible to get the frame boundary when RFmx detects DMRS parameters automatically.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoDmrsDetectionEnabled):: Specifies whether you configure the values of the demodulation reference signal (DMRS) parameters, such as UPLINK_GROUP_HOPPING_ENABLED, UPLINK_SEQUENCE_HOPPING_ENABLED, CELL_ID, PUSCH_N_DMRS_1, PUSCH_N_DMRS_2, and PUSCH_DELTA_SEQUENCE_SHIFT properties, or if the values of these attributes are auto-detected by the measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_level_initial_reference_level(selector_string)

Gets the initial reference level that the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 30.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the initial reference level that the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_band(selector_string)

Gets the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 1. Valid values are from 1 to 256, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_center_frequency(selector_string)

Gets the center frequency of the acquired RF signal for a single carrier.

For intra-band carrier aggregation, this attribute specifies the reference frequency of the subblock. This value is expressed in Hz.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the center frequency of the acquired RF signal for a single carrier.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_center_frequency_for_limits(selector_string)

Gets the frequency that determines the SEM mask, IBE limits, and spectral flatness ranges. If you do not set a value for this attribute, the measurement internally uses the CENTER_FREQUENCY for determining SEM mask, IBE limits, and spectral flatness ranges. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the frequency that determines the SEM mask, IBE limits, and spectral flatness ranges. If you do not set a value for this attribute, the measurement internally uses the CENTER_FREQUENCY for determining SEM mask, IBE limits, and spectral flatness ranges. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_digital_edge_trigger_edge(selector_string)

Gets the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Edge.

Name (Value)	Description
Rising Edge (0)	The trigger asserts on the rising edge of the signal.
Falling Edge (1)	The trigger asserts on the falling edge of the signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DigitalEdgeTriggerEdge):: Specifies the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_digital_edge_trigger_source(selector_string)

Gets the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_duplex_scheme(selector_string)

Gets the duplexing technique of the signal being measured.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FDD.

Name (Value)	Description
FDD (0)	Specifies that the duplexing technique is frequency-division duplexing.
TDD (1)	Specifies that the duplexing technique is time-division duplexing.
LAA (2)	Specifies that the duplexing technique is license assisted access.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DuplexScheme):: Specifies the duplexing technique of the signal being measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_enodeb_category(selector_string)

Gets the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Wide Area Base Station - Category A.

Name (Value)	Description
Wide Area Base Station - Category A (0)	Specifies eNodeB is Wide Area Base Station - Category A.
Wide Area Base Station - Category B Option 1 (1)	Specifies eNodeB is Wide Area Base Station - Category B Option1.
Wide Area Base Station - Category B Option 2 (2)	Specifies eNodeB is Wide Area Base Station - Category B Option2.
Local Area Base Station (3)	Specifies eNodeB is Local Area Base Station.
Home Base Station (4)	Specifies eNodeB is Home Base Station.
Medium Range Base Station (5)	Specifies eNodeB is Medium Range Base Station.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.eNodeBCategory):: Specifies the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_error_string(error_code)

Gets the description of a driver error code.

Parameters:: error_code (int) – Specifies an error or warning code.
Returns:: Contains the error description.
Return type:: string

get_external_attenuation(selector_string)

Gets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_level(selector_string)

Gets the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_level_type(selector_string)

Gets the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Relative.

Name (Value)	Description
Relative (0)	The IQ Power Edge Level attribute is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level attribute specifies the absolute power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IQPowerEdgeTriggerLevelType):: Specifies the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_slope(selector_string)

Gets whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Slope.

Name (Value)	Description
Rising Slope (0)	The trigger asserts when the signal power is rising.
Falling Slope (1)	The trigger asserts when the signal power is falling.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IQPowerEdgeTriggerSlope):: Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_source(selector_string)

Gets the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_limited_configuration_change(selector_string)

Gets the set of attributes that are considered by RFmx in the locked signal configuration state.

If your test system performs the same measurement at different selected ports, multiple frequencies and/or power levels repeatedly, enabling this attribute can help achieve faster measurements. When you set this attribute to a value other than Disabled, RFmx will use an optimized code path and skip some checks. Because RFmx skips some checks when you use this attribute, you need to be aware of the limitations of this feature, which are listed in the Limitations of the Limited Configuration Change Property topic.

You can also use this attribute to lock a specific instrument configuration for a signal so that every time that you initiate the signal, RFmx applies the RFmxInstr attributes from a locked configuration.

NI recommends you use this attribute in conjunction with named signal configurations. Create named signal configurations for each measurement configuration in your test program and set this attribute to a value other than Disabled for one or more of the named signal configurations. This allows RFmx to pre-compute the acquisition settings for your measurement configurations and re-use the precomputed settings each time you initiate the measurement. You do not need to use this attribute if you create named signals for all the measurement configurations in your test program during test sequence initialization and do not change any RFmxInstr or personality attributes while testing each device under test. RFmx automatically optimizes that use case.

Specify the named signal configuration you are setting this attribute in the selector string input. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Disabled.

Name (Value)	Description
Disabled (0)	This is the normal mode of RFmx operation. All configuration changes in RFmxInstr attributes or in personality attributes will be applied during RFmx Commit.
No Change (1)	Signal configuration is locked after the first Commit of the named signal configuration. Any configuration change thereafter either in RFmxInstr attributes or personality attributes will not be considered by subsequent RFmx Commits or Initiates of this signal. Use No Change if you have created named signal configurations for all measurement configurations but are setting some RFmxInstr attributes. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Frequency (2)	Signal configuration, other than center frequency and external attenuation, is locked after first Commit of the named signal configuration. Thereafter, only the Center Frequency and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Reference Level (3)	Signal configuration, other than the reference level, is locked after first Commit of the named signal configuration. Thereafter only the Reference Level attribute value change will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends that you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Freq and Ref Level (4)	Signal configuration, other than center frequency, reference level, and external attenuation, is locked after first Commit of the named signal configuration. Thereafter only Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type attribute to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Selected Ports, Freq and Ref Level (5)	Signal configuration, other than Selected Ports, Center frequency, Reference level, External attenuation, and RFmxInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only Selected Ports, Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type attribute to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LimitedConfigurationChange):: Specifies the set of attributes that are considered by RFmx in the locked signal configuration state.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_link_direction(selector_string)

Gets the link direction of the received signal.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Uplink.

Name (Value)	Description
Downlink (0)	The measurement uses 3GPP LTE downlink specification to measure the received signal.
Uplink (1)	The measurement uses 3GPP LTE uplink specification to measure the received signal.
Sidelink (2)	The measurement uses 3GPP LTE sidelink specifications to measure the received signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LinkDirection):: Specifies the link direction of the received signal.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_mi_configuration(selector_string)

Gets whether the Mi parameter is specified by section 6.1.2.6 of 3GPP TS 36.141 specification for testing E-TMs or in the Table 6.9-1 of 3GPP TS 36.211 specification. The Mi parameter determines the number of PHICH groups in each downlink subframe, when you set the DUPLEX_SCHEME attribute to TDD.

This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Standard.

Name (Value)	Description
Test Model (0)	Mi parameter is set to 1 as specified in section 6.1.2.6 of 3GPP TS 36.141 specification.
Standard (1)	Mi parameter is specified by the Table 6.9-1 of 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.MiConfiguration):: Specifies whether the Mi parameter is specified by section 6.1.2.6 of 3GPP TS 36.141 specification for testing E-TMs or in the Table 6.9-1 of 3GPP TS 36.211 specification. The Mi parameter determines the number of PHICH groups in each downlink subframe, when you set the DUPLEX_SCHEME attribute to TDD.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_dut_antennas(selector_string)

Gets the number of physical antennas available at the DUT for transmission in a MIMO setup.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1. Valid values are 1, 2, and 4.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of physical antennas available at the DUT for transmission in a MIMO setup.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_subblocks(selector_string)

Gets the number of subblocks that are configured in intra-band non-contiguous carrier aggregation.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1. Set this attribute to 1 for single carrier and intra-band contiguous carrier aggregation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of subblocks that are configured in intra-band non-contiguous carrier aggregation.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_reference_level(selector_string)

Gets the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_reference_level_headroom(selector_string)

Gets the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the Reference Level plus the Reference Level Headroom. If you know the input power of the signal precisely or previously included the margin in the Reference Level, you could improve the signal-to-noise ratio by reducing the Reference Level Headroom.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

**Supported devices: **PXIe-5668, PXIe-5830/5831/5832/5840/5841/5842/5860.

Default values

Name (value)	Description
PXIe-5668	6 dB
PXIe-5830/5831/5832/5841/5842/5860	1 dB
PXIe-5840	0 dB

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_result_fetch_timeout(selector_string)

Gets the time to wait before results are available in the RFmxLTE Attribute. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmx Attribute waits until the measurement is complete.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the time to wait before results are available in the RFmxLTE Attribute. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmx Attribute waits until the measurement is complete.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_selected_ports(selector_string)

Gets the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Valid values

Name (value)	Description
PXIe-5830	if0, if1
PXIe-5831/5832	if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel
Other devices	“” (empty string)

Default values

Name (value)	Description
PXIe-5830/5831/5832	if1
Other devices	“” (empty string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_special_subframe_configuration(selector_string)

Gets the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0. Valid values are 0 to 9, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_subblock_frequency(selector_string)

Gets the offset of the subblock from the center frequency. This value is expressed in Hz.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the offset of the subblock from the center frequency. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_transmit_antenna_to_analyze(selector_string)

Gets the physical antenna connected to the analyzer.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0. Valid values are from 0 to N-1, where N is the number of DUT antennas.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the physical antenna connected to the analyzer.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_transmitter_architecture(selector_string)

Gets the RF architecture at the transmitter in case of a multicarrier. 3GPP defines different options, each component carriers within a subblock can have separate LO or one common LO for an entire subblock. Based upon the selected option, the additional results are calculated.

The measurement ignores this attribute when you set the LINK_DIRECTION attribute to Downlink.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is LO per Component Carrier.

Name (Value)	Description
LO per Component Carrier (0)	IQ impairments and In-band emission are calculated per component carrier.
LO per Subblock (1)	Additional subblock based results such as Subblock IQ Offset and Subblock In band emission are calculated apart from per carrier results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TransmitterArchitecture):: Specifies the RF architecture at the transmitter in case of a multicarrier. 3GPP defines different options, each component carriers within a subblock can have separate LO or one common LO for an entire subblock. Based upon the selected option, the additional results are calculated.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_delay(selector_string)

Gets the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pre-trigger samples. If the delay is positive, the measurement acquires post-trigger samples.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pre-trigger samples. If the delay is positive, the measurement acquires post-trigger samples.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_minimum_quiet_time_duration(selector_string)

Gets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.

If you set the IQ_POWER_EDGE_TRIGGER_SLOPE attribute to Rising Slope, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope attribute to Falling Slope, the signal is quiet above the trigger level.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_minimum_quiet_time_mode(selector_string)

Gets whether the measurement computes the minimum quiet time used for triggering.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Auto.

Name (Value)	Description
Manual (0)	The minimum quiet time for triggering is the value of the Trigger Min Quiet Time attribute.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TriggerMinimumQuietTimeMode):: Specifies whether the measurement computes the minimum quiet time used for triggering.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_type(selector_string)

Gets the trigger type.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is None.

Name (Value)	Description
None (0)	No Reference Trigger is configured.
Digital Edge (1)	The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the Digital Edge Source attribute.
IQ Power Edge (2)	The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the IQ Power Edge Slope attribute.
Software (3)	The Reference Trigger is not asserted until a software trigger occurs.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TriggerType):: Specifies the trigger type.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_uplink_downlink_configuration(selector_string)

Gets the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Name (Value)	Description
0 (0)	The configuration of the LTE frame structure in the TDD duplex mode is 0.
1 (1)	The configuration of the LTE frame structure in the TDD duplex mode is 1.
2 (2)	The configuration of the LTE frame structure in the TDD duplex mode is 2.
3 (3)	The configuration of the LTE frame structure in the TDD duplex mode is 3.
4 (4)	The configuration of the LTE frame structure in the TDD duplex mode is 4.
5 (5)	The configuration of the LTE frame structure in the TDD duplex mode is 5.
6 (6)	The configuration of the LTE frame structure in the TDD duplex mode is 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.UplinkDownlinkConfiguration):: Specifies the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_warning()

Retrieves and then clears the warning information for the session.

Returns:

warning_code (int):: Contains the latest warning code.
warning_message (string):: Contains the latest warning description.

Return type:

Tuple (warning_code, warning_message)

initiate(selector_string, result_name)

Initiates all enabled measurements. Call this method after configuring the signal and measurement. This method asynchronously launches measurements in the background and immediately returns to the caller program. You can fetch measurement results using the Fetch methods or result attributes in the attribute node. To get the status of measurements, use the wait_for_measurement_complete() method or check_measurement_status() method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of result name. The result name can either be specified through this input or the Result Name parameter. If you do not specify the result name in this input, either the result name specified by Result Name parameter or the default result instance is used. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.
result_name (string) –
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as “r1” to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the “result::” prefix. The default value is “” (empty string) which refers to default result instance.

Example:

”result::r1”

”r1”

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

reset_attribute(selector_string, attribute_id)

Resets the attribute to its default value.

Parameters:

selector_string (string) – Specifies the selector string for the property being reset.
attribute_id (PropertyId) – Specifies an attribute identifier.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

reset_to_default(selector_string)

Resets a signal to the default values.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

select_measurements(selector_string, measurements, enable_all_traces)

Enables all the measurements that you specify in the Measurements parameter and disables all other measurements.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

measurements (enums.MeasurementTypes, int) –

This parameter specifies the measurements to perform. You can specify one or more of the following measurements. The default value is an empty array.

Name (Value)	Description
ACP (0)	Enables the ACP measurement.
CHP (1)	Enables the CHP measurement.
ModAcc (2)	Enables the ModAcc measurement.
OBW (3)	Enables the OBW measurement.
SEM (4)	Enables the SEM measurement.
PVT (5)	Enables the PVT measurement.
SlotPhase (6)	Enables the SlotPhase measurement.
SlotPower (7)	Enables the SlotPower measurement.

enable_all_traces (bool) – This parameter specifies whether to enable all traces for the selected measurement. The default value is FALSE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

send_software_edge_trigger()

Sends a trigger to the device when you use the [RFmxLTE Configure Trigger](RFmxLTE_Configure_Trigger.html) function to choose a software version of a trigger and the device is waiting for the trigger to be sent. You can also use this function to override a hardware trigger.

This function returns an error in the following situations:

You configure an invalid trigger.
You have not previously called the initiate function.

Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

set_acquisition_bandwidth_optimization_enabled(selector_string, value)

Sets whether RFmx optimizes the acquisition bandwidth. This may cause acquisition center frequency or local oscillator (LO) to be placed at different position than you configured.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Refer to the Acquisition Bandwidth Optimization Enabled topic for more information.

The default value is True.

Name (Value)	Description
False (0)	RFmx does not optimize acquisition bandwidth and will be based on the Nyquist criterion. The value of the acquisition center frequency is the same as the value of the Center Frequency that you configure.
True (1)	RFmx positions the acquisition center frequency to acquire the least bandwidth based on the configuration and span needed for the measurement. This helps in reducing the amount of data to process for the measurement, thus improving the speed. However this might cause the LO to be positioned at a non-dc subcarrier position, hence the measurement sensitive to it should have this attribute disabled.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcquisitionBandwidthOptimizationEnabled, int) – Specifies whether RFmx optimizes the acquisition bandwidth. This may cause acquisition center frequency or local oscillator (LO) to be placed at different position than you configured.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_auto_dmrs_detection_enabled(selector_string, value)

Sets whether you configure the values of the demodulation reference signal (DMRS) parameters, such as UPLINK_GROUP_HOPPING_ENABLED, UPLINK_SEQUENCE_HOPPING_ENABLED, CELL_ID, PUSCH_N_DMRS_1, PUSCH_N_DMRS_2, and PUSCH_DELTA_SEQUENCE_SHIFT properties, or if the values of these attributes are auto-detected by the measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The user-specified DMRS parameters are used.
True (1)	The values of the DMRS parameters are automatically detected. Measurement returns an error if you set the ModAcc Sync Mode attribute to Frame, since it is not possible to get the frame boundary when RFmx detects DMRS parameters automatically.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoDmrsDetectionEnabled, int) – Specifies whether you configure the values of the demodulation reference signal (DMRS) parameters, such as UPLINK_GROUP_HOPPING_ENABLED, UPLINK_SEQUENCE_HOPPING_ENABLED, CELL_ID, PUSCH_N_DMRS_1, PUSCH_N_DMRS_2, and PUSCH_DELTA_SEQUENCE_SHIFT properties, or if the values of these attributes are auto-detected by the measurement.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_auto_level_initial_reference_level(selector_string, value)

Sets the initial reference level that the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 30.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the initial reference level that the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_band(selector_string, value)

Sets the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 1. Valid values are from 1 to 256, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the evolved universal terrestrial radio access (E-UTRA) operating frequency band of a subblock, as defined in section 5.2 of the 3GPP TS 36.521 specification.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_center_frequency(selector_string, value)

Sets the center frequency of the acquired RF signal for a single carrier.

For intra-band carrier aggregation, this attribute specifies the reference frequency of the subblock. This value is expressed in Hz.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the center frequency of the acquired RF signal for a single carrier.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_center_frequency_for_limits(selector_string, value)

Sets the frequency that determines the SEM mask, IBE limits, and spectral flatness ranges. If you do not set a value for this attribute, the measurement internally uses the CENTER_FREQUENCY for determining SEM mask, IBE limits, and spectral flatness ranges. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the frequency that determines the SEM mask, IBE limits, and spectral flatness ranges. If you do not set a value for this attribute, the measurement internally uses the CENTER_FREQUENCY for determining SEM mask, IBE limits, and spectral flatness ranges. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_digital_edge_trigger_edge(selector_string, value)

Sets the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Edge.

Name (Value)	Description
Rising Edge (0)	The trigger asserts on the rising edge of the signal.
Falling Edge (1)	The trigger asserts on the falling edge of the signal.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DigitalEdgeTriggerEdge, int) – Specifies the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_digital_edge_trigger_source(selector_string, value)

Sets the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_duplex_scheme(selector_string, value)

Sets the duplexing technique of the signal being measured.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is FDD.

Name (Value)	Description
FDD (0)	Specifies that the duplexing technique is frequency-division duplexing.
TDD (1)	Specifies that the duplexing technique is time-division duplexing.
LAA (2)	Specifies that the duplexing technique is license assisted access.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DuplexScheme, int) – Specifies the duplexing technique of the signal being measured.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_enodeb_category(selector_string, value)

Sets the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Wide Area Base Station - Category A.

Name (Value)	Description
Wide Area Base Station - Category A (0)	Specifies eNodeB is Wide Area Base Station - Category A.
Wide Area Base Station - Category B Option 1 (1)	Specifies eNodeB is Wide Area Base Station - Category B Option1.
Wide Area Base Station - Category B Option 2 (2)	Specifies eNodeB is Wide Area Base Station - Category B Option2.
Local Area Base Station (3)	Specifies eNodeB is Local Area Base Station.
Home Base Station (4)	Specifies eNodeB is Home Base Station.
Medium Range Base Station (5)	Specifies eNodeB is Medium Range Base Station.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.eNodeBCategory, int) – Specifies the downlink eNodeB (Base station) category. Refer to the 3GPP 36.141 specification for more details.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_external_attenuation(selector_string, value)

Sets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. Refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help for more information about attenuation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_level(selector_string, value)

Sets the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_level_type(selector_string, value)

Sets the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Relative.

Name (Value)	Description
Relative (0)	The IQ Power Edge Level attribute is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level attribute specifies the absolute power.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.IQPowerEdgeTriggerLevelType, int) – Specifies the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_slope(selector_string, value)

Sets whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Slope.

Name (Value)	Description
Rising Slope (0)	The trigger asserts when the signal power is rising.
Falling Slope (1)	The trigger asserts when the signal power is falling.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.IQPowerEdgeTriggerSlope, int) – Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_source(selector_string, value)

Sets the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_limited_configuration_change(selector_string, value)

Sets the set of attributes that are considered by RFmx in the locked signal configuration state.

If your test system performs the same measurement at different selected ports, multiple frequencies and/or power levels repeatedly, enabling this attribute can help achieve faster measurements. When you set this attribute to a value other than Disabled, RFmx will use an optimized code path and skip some checks. Because RFmx skips some checks when you use this attribute, you need to be aware of the limitations of this feature, which are listed in the Limitations of the Limited Configuration Change Property topic.

You can also use this attribute to lock a specific instrument configuration for a signal so that every time that you initiate the signal, RFmx applies the RFmxInstr attributes from a locked configuration.

NI recommends you use this attribute in conjunction with named signal configurations. Create named signal configurations for each measurement configuration in your test program and set this attribute to a value other than Disabled for one or more of the named signal configurations. This allows RFmx to pre-compute the acquisition settings for your measurement configurations and re-use the precomputed settings each time you initiate the measurement. You do not need to use this attribute if you create named signals for all the measurement configurations in your test program during test sequence initialization and do not change any RFmxInstr or personality attributes while testing each device under test. RFmx automatically optimizes that use case.

Specify the named signal configuration you are setting this attribute in the selector string input. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Disabled.

Name (Value)	Description
Disabled (0)	This is the normal mode of RFmx operation. All configuration changes in RFmxInstr attributes or in personality attributes will be applied during RFmx Commit.
No Change (1)	Signal configuration is locked after the first Commit of the named signal configuration. Any configuration change thereafter either in RFmxInstr attributes or personality attributes will not be considered by subsequent RFmx Commits or Initiates of this signal. Use No Change if you have created named signal configurations for all measurement configurations but are setting some RFmxInstr attributes. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Frequency (2)	Signal configuration, other than center frequency and external attenuation, is locked after first Commit of the named signal configuration. Thereafter, only the Center Frequency and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Reference Level (3)	Signal configuration, other than the reference level, is locked after first Commit of the named signal configuration. Thereafter only the Reference Level attribute value change will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends that you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Freq and Ref Level (4)	Signal configuration, other than center frequency, reference level, and external attenuation, is locked after first Commit of the named signal configuration. Thereafter only Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type attribute to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Selected Ports, Freq and Ref Level (5)	Signal configuration, other than Selected Ports, Center frequency, Reference level, External attenuation, and RFmxInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only Selected Ports, Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type attribute to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LimitedConfigurationChange, int) – Specifies the set of attributes that are considered by RFmx in the locked signal configuration state.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_link_direction(selector_string, value)

Sets the link direction of the received signal.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Uplink.

Name (Value)	Description
Downlink (0)	The measurement uses 3GPP LTE downlink specification to measure the received signal.
Uplink (1)	The measurement uses 3GPP LTE uplink specification to measure the received signal.
Sidelink (2)	The measurement uses 3GPP LTE sidelink specifications to measure the received signal.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LinkDirection, int) – Specifies the link direction of the received signal.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_mi_configuration(selector_string, value)

Sets whether the Mi parameter is specified by section 6.1.2.6 of 3GPP TS 36.141 specification for testing E-TMs or in the Table 6.9-1 of 3GPP TS 36.211 specification. The Mi parameter determines the number of PHICH groups in each downlink subframe, when you set the DUPLEX_SCHEME attribute to TDD.

This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Standard.

Name (Value)	Description
Test Model (0)	Mi parameter is set to 1 as specified in section 6.1.2.6 of 3GPP TS 36.141 specification.
Standard (1)	Mi parameter is specified by the Table 6.9-1 of 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.MiConfiguration, int) – Specifies whether the Mi parameter is specified by section 6.1.2.6 of 3GPP TS 36.141 specification for testing E-TMs or in the Table 6.9-1 of 3GPP TS 36.211 specification. The Mi parameter determines the number of PHICH groups in each downlink subframe, when you set the DUPLEX_SCHEME attribute to TDD.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_dut_antennas(selector_string, value)

Sets the number of physical antennas available at the DUT for transmission in a MIMO setup.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1. Valid values are 1, 2, and 4.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of physical antennas available at the DUT for transmission in a MIMO setup.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_subblocks(selector_string, value)

Sets the number of subblocks that are configured in intra-band non-contiguous carrier aggregation.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1. Set this attribute to 1 for single carrier and intra-band contiguous carrier aggregation.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of subblocks that are configured in intra-band non-contiguous carrier aggregation.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_reference_level(selector_string, value)

Sets the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the reference level which represents the maximum expected power of the RF input signal. This value is configured in dBm for RF devices and as Vpk-pk for baseband devices.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_reference_level_headroom(selector_string, value)

Sets the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the Reference Level plus the Reference Level Headroom. If you know the input power of the signal precisely or previously included the margin in the Reference Level, you could improve the signal-to-noise ratio by reducing the Reference Level Headroom.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

**Supported devices: **PXIe-5668, PXIe-5830/5831/5832/5840/5841/5842/5860.

Default values

Name (value)	Description
PXIe-5668	6 dB
PXIe-5830/5831/5832/5841/5842/5860	1 dB
PXIe-5840	0 dB

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_result_fetch_timeout(selector_string, value)

Sets the time to wait before results are available in the RFmxLTE Attribute. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmx Attribute waits until the measurement is complete.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the time to wait before results are available in the RFmxLTE Attribute. This value is expressed in seconds. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmx Attribute waits until the measurement is complete.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_selected_ports(selector_string, value)

Sets the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Valid values

Name (value)	Description
PXIe-5830	if0, if1
PXIe-5831/5832	if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel
Other devices	“” (empty string)

Default values

Name (value)	Description
PXIe-5830/5831/5832	if1
Other devices	“” (empty string)

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_special_subframe_configuration(selector_string, value)

Sets the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0. Valid values are 0 to 9, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the special subframe configuration index. It defines the length of DwPTS, GP, and UpPTS for TDD transmission as defined in the section 4.2 of 3GPP 36.211 specification.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_subblock_frequency(selector_string, value)

Sets the offset of the subblock from the center frequency. This value is expressed in Hz.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the offset of the subblock from the center frequency. This value is expressed in Hz.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_transmit_antenna_to_analyze(selector_string, value)

Sets the physical antenna connected to the analyzer.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0. Valid values are from 0 to N-1, where N is the number of DUT antennas.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the physical antenna connected to the analyzer.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_transmitter_architecture(selector_string, value)

Sets the RF architecture at the transmitter in case of a multicarrier. 3GPP defines different options, each component carriers within a subblock can have separate LO or one common LO for an entire subblock. Based upon the selected option, the additional results are calculated.

The measurement ignores this attribute when you set the LINK_DIRECTION attribute to Downlink.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is LO per Component Carrier.

Name (Value)	Description
LO per Component Carrier (0)	IQ impairments and In-band emission are calculated per component carrier.
LO per Subblock (1)	Additional subblock based results such as Subblock IQ Offset and Subblock In band emission are calculated apart from per carrier results.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TransmitterArchitecture, int) – Specifies the RF architecture at the transmitter in case of a multicarrier. 3GPP defines different options, each component carriers within a subblock can have separate LO or one common LO for an entire subblock. Based upon the selected option, the additional results are calculated.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_delay(selector_string, value)

Sets the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pre-trigger samples. If the delay is positive, the measurement acquires post-trigger samples.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the trigger delay time. This value is expressed in seconds. If the delay is negative, the measurement acquires pre-trigger samples. If the delay is positive, the measurement acquires post-trigger samples.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_minimum_quiet_time_duration(selector_string, value)

Sets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.

If you set the IQ_POWER_EDGE_TRIGGER_SLOPE attribute to Rising Slope, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope attribute to Falling Slope, the signal is quiet above the trigger level.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_minimum_quiet_time_mode(selector_string, value)

Sets whether the measurement computes the minimum quiet time used for triggering.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Auto.

Name (Value)	Description
Manual (0)	The minimum quiet time for triggering is the value of the Trigger Min Quiet Time attribute.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TriggerMinimumQuietTimeMode, int) – Specifies whether the measurement computes the minimum quiet time used for triggering.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_type(selector_string, value)

Sets the trigger type.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is None.

Name (Value)	Description
None (0)	No Reference Trigger is configured.
Digital Edge (1)	The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the Digital Edge Source attribute.
IQ Power Edge (2)	The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the IQ Power Edge Slope attribute.
Software (3)	The Reference Trigger is not asserted until a software trigger occurs.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TriggerType, int) – Specifies the trigger type.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_uplink_downlink_configuration(selector_string, value)

Sets the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Name (Value)	Description
0 (0)	The configuration of the LTE frame structure in the TDD duplex mode is 0.
1 (1)	The configuration of the LTE frame structure in the TDD duplex mode is 1.
2 (2)	The configuration of the LTE frame structure in the TDD duplex mode is 2.
3 (3)	The configuration of the LTE frame structure in the TDD duplex mode is 3.
4 (4)	The configuration of the LTE frame structure in the TDD duplex mode is 4.
5 (5)	The configuration of the LTE frame structure in the TDD duplex mode is 5.
6 (6)	The configuration of the LTE frame structure in the TDD duplex mode is 6.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.UplinkDownlinkConfiguration, int) – Specifies the configuration of the LTE frame structure in the time division duplex (TDD) mode. Refer to table 4.2-2 of the 3GPP TS 36.211 specification to configure the LTE frame.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

signal_configuration_name = '': Name assigned to the current signal configuration object.

signal_configuration_type = None: Type of the current signal configuration object.

wait_for_measurement_complete(selector_string, timeout)

Waits for the specified number for seconds for all the measurements to complete.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.
timeout (float) – This parameter specifies the timeout for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int