CDMA2k

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

class nirfmxcdma2k.cdma2k.Cdma2k(session, signal_name='', cloning=False)[source]

Bases: _Cdma2kBase

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

abort_measurements(selector_string)

Stops acquisition and measurements associated with the signal instance that you specify in the Selector String parameter. The acquisition and measurements 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 RFmxCDMA2k, 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.

The RFmxCDMA2k Auto Level method does 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 the AUTO_LEVEL_INITIAL_REFERENCE_LEVEL attribute.

When using NI 5663, 5665, or 5668R devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmxCDMA2k 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.

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 expressed in dBm for RF devices and V_pk-pkfor 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_channel_string(selector_string, channel_number)

Creates a selector string to use with channel configuration.

Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
channel_number (int) – This parameter specifies the channel number used to build the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_offset_string(selector_string, offset_number)

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

Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
offset_number (int) – This parameter specifies the offset number used to build 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

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 result name. Examples:

””

”signal::sig1”

”result::r1”

”signal::sig1/result::r1”

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

Returns:

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 (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 result name. Examples:

””

”signal::sig1”

”result::r1”

”signal::sig1/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 (Cdma2k):: Contains a new CDMA2k 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. RFmxCDMA2k 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_band_class(selector_string, band_class)

Configures the band class used for the measurement.

Parameters:

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

band_class (int) –

This parameter specifies the band in which the channel is located as defined in Section: 1.5, Table 1.5-1: Band Class List, of the 3GPP2 C.S0057-F specification v1.0. The default value is 0.

Name (value)	Description
0 (0)	Specifies the 800 MHz cellular band.
1 (1)	Specifies the 1.8 GHz to 2.0 GHz PCS band.
2 (2)	Specifies the 872 MHz to 960 MHz TACS band.
3 (3)	Specifies the 832 MHz to 925 MHZ JTACS band.
4 (4)	Specifies the 1.75 GHz to 1.87 GHz Korean PCS band.
5 (5)	Specifies the 450 MHz NMT band.
6 (6)	Specifies the 2 GHz IMT-2000 band.
7 (7)	Specifies the upper 700 MHz PARMR band.
8 (8)	Specifies the 1,800 MHz to 2 GHz band.
9 (9)	Specifies the 900 MHz band.
10 (10)	Specifies the secondary 1,800 MHz band.
11 (11)	Specifies the 400 MHz European PAMR band.
12 (12)	Specifies the 800 MHz PAMR band.
14 (14)	Specifies the US PCS 1.9 GHz band.
15 (15)	Specifies the AWS band.

Returns:

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

Return type:

int

configure_channel_configuration_mode(selector_string, channel_configuration_mode)

Configures RFmx CDMA2k to detect the channels automatically or to use a specified channel configuration.

Parameters:

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

channel_configuration_mode (enums.ChannelConfigurationMode, int) –

This parameter specifies whether to detect the channels automatically or to use a specified channel configuration.

This parameter has no effect if radio configuration 1 or 2 (RC1 or RC2) is configured, as RC1 and RC2 always use a single 64-ary Walsh-modulated channel.

Name (value)	Description
Auto Detect (0)	Specifies that the system automatically detects the channels.
User Defined (1)	Specifies that the system uses a specific channel configuration. This mode increases measurement speed because no time is spent on channel detection.

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

digital_edge (enums.DigitalEdgeTriggerEdge, int) –
This parameter specifies the trigger edge to detect. 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. 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_external_attenuation(selector_string, external_attenuation)

Specifies any external attenuation to be considered by RFmx CDMA2k measurements, such as the attenuation of a switch or cable connected to the signal analyzer RF IN connector.

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 signal analyzer RF IN connector. This value is expressed in dB. The default value is 0 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 carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. This value is expressed in Hz. 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_channel_number(selector_string, link_direction, band_class, channel_number)

Configures the expected carrier frequency of the RF signal to acquire according to the given channel number. 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.
link_direction (enums.LinkDirection, int) –
This parameter specifies the direction for which the frequency is calculated. Currently only Uplink is supported.

Name (value)

Description

Uplink (1)

The frequency is calculated in the reverse link direction, also known as the uplink direction.

band_class (int) –

This parameter specifies the band in which the channel is located as defined in Section: 1.5, Table 1.5-1: Band Class List, of the 3GPP2 C.S0057-F specification v1.0. The default value is 0.

Name (value)	Description
0 (0)	Specifies the 800 MHz cellular band.
1 (1)	Specifies the 1.8 GHz to 2.0 GHz PCS band.
2 (2)	Specifies the 872 MHz to 960 MHz TACS band.
3 (3)	Specifies the 832 MHz to 925 MHZ JTACS band.
4 (4)	Specifies the 1.75 GHz to 1.87 GHz Korean PCS band.
5 (5)	Specifies the 450 MHz NMT band.
6 (6)	Specifies the 2 GHz IMT-2000 band.
7 (7)	Specifies the upper 700 MHz PARMR band.
8 (8)	Specifies the 1,800 MHz to 2 GHz band.
9 (9)	Specifies the 900 MHz band.
10 (10)	Specifies the secondary 1,800 MHz band.
11 (11)	Specifies the 400 MHz European PAMR band.
12 (12)	Specifies the 800 MHz PAMR band.
14 (14)	Specifies the US PCS 1.9 GHz band.
15 (15)	Specifies the AWS band.

channel_number (int) – This parameter specifies the channel number used 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

configure_iq_power_edge_trigger(selector_string, iq_power_edge_source, iq_power_edge_slope, iq_power_edge_level, trigger_delay, minimum_quiet_time_mode, minimum_quiet_time, 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 to mark a reference point within the record.

To trigger on burst signals, specify a minimum quiet time. The minimum quiet time 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. 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. 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 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. The default of this attribute is hardware dependent.
trigger_delay (float) – This parameter specifies whether the trigger is used. The default value is TRUE.
minimum_quiet_time_mode (enums.TriggerMinimumQuietTimeMode, int) – This parameter specifies the trigger delay time. This value is expressed in seconds. The default value is 0.

minimum_quiet_time (float) –

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 you specify using the Minimum Quiet Time input.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

iq_power_edge_level_type (enums.IQPowerEdgeTriggerLevelType, int) –
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 while it is below the trigger level. If you set the IQ Power Edge Slope parameter to Falling Slope, the signal is quiet when it is above the trigger level. The default value of this parameter is hardware dependent.

enable_trigger (bool) –

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.

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_channels(selector_string, number_of_channels)

Configures the number of channels for the user-defined channel configuration when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_channels (int) – This parameter specifies the number of user-defined channels. 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_radio_configuration(selector_string, radio_configuration)

Configures the radio configuration of the CDMA2k signal.

Parameters:

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

radio_configuration (enums.RadioConfiguration, int) –

This parameter specifies the radio configuration of the CDMA2k signal to be analyzed. The default value is RC3.

Name (value)	Description
RC1 (0)	For Uplink, Radio configuration 1 includes 64-ary orthogonal modulation, reverse fundamental channel (R-FCH) and reverse supplemental code channels (R-SCCHs). For Downlink, Radio Configuration 1 includes binary phase-shift keying (BPSK), forward fundamental channels (F-FCHs) and forward supplemental channels (F-SCHs).
RC2 (1)	For Uplink, Radio configuration 2 includes 64-ary orthogonal modulation, R-FCH and R-SCCHs. For Downlink, Radio Configuration 2 includes BPSKs, F-FCHs and F-SCHs.
RC3 (2)	For Uplink, Radio configuration 3 includes binary phase shift keying (BPSK), R-FCH and reverse supplemental channels (R-SCHs). For Downlink, Radio Configuration 3 includes quadrature phase-shift keying (QPSK), F-FCHs and F-SCHs.
RC4 (3)	For Uplink, Radio configuration 4 includes BPSK, R-FCH and R-SCHs. For Downlink, Radio Configuration 4 includes QPSK, F-FCHs and F-SCHs.
RC5 (4)	For Uplink, Radio configuration 5 is not supported. For Downlink, Radio Configuration 5 includes QPSK, F-FCHs and F-SCHs.

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. The reference level represents the maximum expected power of an input RF 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 an RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor 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 parameter.

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 carrier frequency of the RF signal to acquire. This value is expressed in Hz. The signal analyzer tunes to this frequency. The default value of this parameter is hardware dependent. Refer to the 3GPP2 standard C.S0057-E v1.0 for more information about bands.
reference_level (float) – This parameter specifies the reference level, which represents the maximum expected power of an RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor 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. 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_uplink_spreading(selector_string, uplink_spreading_long_code_mask)

Configures the scrambling code used for the uplink transmission.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
uplink_spreading_long_code_mask (int) – This parameter specifies the long code mask for uplink spreading. This number is a 42-bit binary number, represented as a 64-bit integer. 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_user_defined_channel(selector_string, walsh_code_length, walsh_code_number, branch)

Configures an individual user-defined channel when the channel configuration mode is set to User Defined.

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

A channel is defined by the Walsh code length and number and the quadrature branch on which it is mapped.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of channel number. Examples:

”channel0”

”signal::sig1/channel0”

You can use the build_channel_string() method to build the selector string.
walsh_code_length (int) – This parameter specifies the Walsh code length of a specific user-defined channel. The default value is 64.
walsh_code_number (int) – This parameter specifies the Walsh code number of a specific user-defined channel. The default value is 0.
branch (enums.Branch, int) –
This parameter specifies the branch on which a specific user-defined channel is mapped. The default value is I.

Name (value)

Description

I (0)

Specifies the in-phase branch.

Q (1)

Specifies the quadrature branch.

I and Q (2)

Specifies the in-phase and quadrature branch.

Returns:

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

Return type:

int

configure_user_defined_channel_array(selector_string, walsh_code_length, walsh_code_number, branch)

Configures all user-defined channels when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use equal-sized arrays for Walsh Code Length, Walsh Code Number, and Branch.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
walsh_code_length (int) – This parameter specifies an array of the Walsh code length of the CDMA2k signal. The default value is 64.
walsh_code_number (int) – This parameter specifies an array of the Walsh code number of the CDMA2k signal. The default value is 0.
branch (enums.Branch, int) –
This parameter specifies an array of the branch on which a specific user-defined channel is mapped. The default value is I.

Name (value)

Description

I (0)

Specifies the in-phase branch.

Q (1)

Specifies the quadrature branch.

I and Q (2)

Specifies the in-phase and quadrature branch.

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_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_level_initial_reference_level(selector_string)

Gets the initial reference level that the RFmxCDMA2k Auto Level method uses to estimate the peak power of the input signal. This value is expressed in dBm.

The default value is 30 dBm.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the initial reference level that the RFmxCDMA2k 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_class(selector_string)

Gets the band in which the channel is located as defined in Section: 1.5, Table 1.5- Band Class List, of the 3GPP2 C.S0057-F specification v1.0.

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 12, 14 and 15.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the band in which the channel is located as defined in Section: 1.5, Table 1.5- Band Class List, of the 3GPP2 C.S0057-F specification v1.0.
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_branch(selector_string)

Gets the branch on which a specific user-defined channel is mapped. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to configure or read this attribute.

The default value is I.

Name (Value)	Description
I (0)	Specifies the in-phase branch.
Q (1)	Specifies the quadrature branch.
I and Q (2)	Specifies the in-phase and quadrature branch.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.Branch):: Specifies the branch on which a specific user-defined channel is mapped. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.
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 carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. 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.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this 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_channel_configuration_mode(selector_string)

Gets whether to detect the channels automatically or to use a specified channel configuration.

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 Detect.

Name (Value)	Description
Auto Detect (0)	Specifies that the system automatically detects the channels.
User Defined (1)	Specifies that the system uses a specific channel configuration.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ChannelConfigurationMode):: Specifies whether to detect the channels automatically or to use a specified channel configuration.
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_downlink_spreading_pn_offset(selector_string)

Specified the PN offset in increments of 64 chips for forward link.

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 (int):: Specified the PN offset in increments of 64 chips for forward link.
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. 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.

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 dB.

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. 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.
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 the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute is set to Relative and in dBm when the IQ Power Edge Level Type attribute is set 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 the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute is set to Relative and in dBm when the IQ Power Edge Level Type attribute is set 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 Level Type attribute. 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 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 Level Type attribute. 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_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, the RFmx driver 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 precompute 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 RFInstr 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 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 RFInstr 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 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)	CDMA2k measurement uses 3GPP CDMA2k forward link direction also known as downlink direction to measure the received signal.
Uplink (1)	CDMA2k measurement uses 3GPP CDMA2k reverse link direction also known as uplink direction 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_number_of_channels(selector_string)

Gets the number of user-defined channels. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

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 (int):: Specifies the number of user-defined channels. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.
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_radio_configuration(selector_string)

Gets the radio configuration for the channel.

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 RC3.

Name (Value)	Description
RC1 (0)	If Link Direction attribute is set to Uplink, Radio configuration 1 includes 64-ary orthogonal modulation, reverse fundamental channel (R-FCH), and reverse supplemental code channels (R-SCCHs). If Link Direction attribute is set to Downlink, Radio Configuration 1 includes binary phase-shift keying (BPSK), forward fundamental channels (F-FCHs) and forward supplemental channels (F-SCHs).
RC2 (1)	If Link Direction attribute is set to Uplink, Radio configuration 2 includes 64-ary orthogonal modulation, R-FCH, and R-SCCHs. If Link Direction attribute is set to Downlink, Radio Configuration 2 includes BPSKs, F-FCHs and F-SCHs.
RC3 (2)	If Link Direction attribute is set to Uplink, Radio configuration 3 includes BPSK, R-FCH, and reverse supplemental channels (R-SCHs). If Link Direction attribute is set to Downlink, Radio Configuration 3 includes quadrature phase-shift keying (QPSK), F-FCHs and F-SCHs.
RC4 (3)	If Link Direction attribute is set to Uplink, Radio configuration 4 includes BPSK, R-FCH, and R-SCHs. If Link Direction attribute is set to Downlink, Radio Configuration 4 includes QPSK, F-FCHs and F-SCHs.
RC5 (4)	If Link Direction attribute is set to Uplink, Radio configuration 5 is not supported and gives invalid results. If Link Direction attribute is set to Downlink, Radio Configuration 5 includes QPSK, F-FCHs and F-SCHs.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.RadioConfiguration):: Specifies the radio configuration for the channel.
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 expressed in dBm for RF devices and V_pk-pkfor 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 expressed in dBm for RF devices and V_pk-pkfor 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-5668R, 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 RFmxCDMA2k 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 RFmxCDMA2k Attribute waits until the measurement is complete before fetching the measurement.

The default value is 10 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the time to wait before results are available in the RFmxCDMA2k Attribute. 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_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_trigger_delay(selector_string)

Gets 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.

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 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the trigger delay time. 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_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 Source 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_spreading_long_code_mask(selector_string)

Gets the long code mask for reverse link spreading.

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 (int):: Specifies the long code mask for reverse link spreading.
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_walsh_code_length(selector_string)

Gets the Walsh code length of a specific user-defined channel. This value is expressed in chips. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to configure or read this attribute.

The default value is 64.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the Walsh code length of a specific user-defined channel. This value is expressed in chips. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.
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_walsh_code_number(selector_string)

Gets the Walsh code number of a specific user-defined channel. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use “channel< <format type=”monospace-italic”>n</format> >” 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 (int):: Specifies the Walsh code number of a specific user-defined channel. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.
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 the signal name and the result name. The result name can either by specified through this input or the Result Name input. If you do not specify the result name in this input, either the result name specified by the Result Name input or the default result instance is used.

Examples:

””

”signal::sig1”

”result::r1”

”signal::sig1/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.

Examples:

””

”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 configuration 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.

The default is an empty array.

Name (value)	Description
ModAcc (0)	Enables the ModAcc measurement.
ACP (1)	Enables the ACP measurement.
CHP (2)	Enables the CHP measurement.
OBW (3)	Enables the OBW measurement.
SEM (4)	Enables the SEM measurement.
QEVM (5)	Enables the QEVM measurement.
CDA (6)	Enables the CDA measurement.
SlotPhase (7)	Enables the SlotPhase measurement.
SlotPower (8)	Enables the SlotPower measurement.

enable_all_traces (bool) – This parameter specifies whether to enable all traces for the selected measurements. 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 RFmxCDMA2k Configure Trigger 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_auto_level_initial_reference_level(selector_string, value)

Sets the initial reference level that the RFmxCDMA2k Auto Level method uses to estimate the peak power of the input signal. This value is expressed in dBm.

The default value is 30 dBm.

Parameters:

selector_string (string) – Pass an empty string.
value (float) –
Specifies the initial reference level that the RFmxCDMA2k 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_class(selector_string, value)

Sets the band in which the channel is located as defined in Section: 1.5, Table 1.5- Band Class List, of the 3GPP2 C.S0057-F specification v1.0.

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 12, 14 and 15.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the band in which the channel is located as defined in Section: 1.5, Table 1.5- Band Class List, of the 3GPP2 C.S0057-F specification v1.0.

Returns:

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

Return type:

int

set_branch(selector_string, value)

Sets the branch on which a specific user-defined channel is mapped. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to configure or read this attribute.

The default value is I.

Name (Value)	Description
I (0)	Specifies the in-phase branch.
Q (1)	Specifies the quadrature branch.
I and Q (2)	Specifies the in-phase and quadrature branch.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.Branch, int) – Specifies the branch on which a specific user-defined channel is mapped. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

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 carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency. 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.

The default value of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the carrier frequency of the RF signal to acquire. The signal analyzer tunes to this 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_channel_configuration_mode(selector_string, value)

Sets whether to detect the channels automatically or to use a specified channel configuration.

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 Detect.

Name (Value)	Description
Auto Detect (0)	Specifies that the system automatically detects the channels.
User Defined (1)	Specifies that the system uses a specific channel configuration.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ChannelConfigurationMode, int) – Specifies whether to detect the channels automatically or to use a specified channel configuration.

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_downlink_spreading_pn_offset(selector_string, value)

Specified the PN offset in increments of 64 chips for forward link.

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 (int) – Specified the PN offset in increments of 64 chips for forward link.

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

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 dB.

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

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 the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute is set to Relative and in dBm when the IQ Power Edge Level Type attribute is set 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 the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute is set to Relative and in dBm when the IQ Power Edge Level Type attribute is set 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 Level Type attribute. 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 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 Level Type attribute. 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_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, the RFmx driver 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 precompute 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 RFInstr 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 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 RFInstr 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 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)	CDMA2k measurement uses 3GPP CDMA2k forward link direction also known as downlink direction to measure the received signal.
Uplink (1)	CDMA2k measurement uses 3GPP CDMA2k reverse link direction also known as uplink direction 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_number_of_channels(selector_string, value)

Sets the number of user-defined channels. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

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 (int) – Specifies the number of user-defined channels. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Returns:

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

Return type:

int

set_radio_configuration(selector_string, value)

Sets the radio configuration for the channel.

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 RC3.

Name (Value)	Description
RC1 (0)	If Link Direction attribute is set to Uplink, Radio configuration 1 includes 64-ary orthogonal modulation, reverse fundamental channel (R-FCH), and reverse supplemental code channels (R-SCCHs). If Link Direction attribute is set to Downlink, Radio Configuration 1 includes binary phase-shift keying (BPSK), forward fundamental channels (F-FCHs) and forward supplemental channels (F-SCHs).
RC2 (1)	If Link Direction attribute is set to Uplink, Radio configuration 2 includes 64-ary orthogonal modulation, R-FCH, and R-SCCHs. If Link Direction attribute is set to Downlink, Radio Configuration 2 includes BPSKs, F-FCHs and F-SCHs.
RC3 (2)	If Link Direction attribute is set to Uplink, Radio configuration 3 includes BPSK, R-FCH, and reverse supplemental channels (R-SCHs). If Link Direction attribute is set to Downlink, Radio Configuration 3 includes quadrature phase-shift keying (QPSK), F-FCHs and F-SCHs.
RC4 (3)	If Link Direction attribute is set to Uplink, Radio configuration 4 includes BPSK, R-FCH, and R-SCHs. If Link Direction attribute is set to Downlink, Radio Configuration 4 includes QPSK, F-FCHs and F-SCHs.
RC5 (4)	If Link Direction attribute is set to Uplink, Radio configuration 5 is not supported and gives invalid results. If Link Direction attribute is set to Downlink, Radio Configuration 5 includes QPSK, F-FCHs and F-SCHs.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.RadioConfiguration, int) – Specifies the radio configuration for the channel.

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 expressed in dBm for RF devices and V_pk-pkfor 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 expressed in dBm for RF devices and V_pk-pkfor 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-5668R, 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 RFmxCDMA2k 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 RFmxCDMA2k Attribute waits until the measurement is complete before fetching the measurement.

The default value is 10 seconds.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the time to wait before results are available in the RFmxCDMA2k Attribute. 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_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_trigger_delay(selector_string, value)

Sets 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.

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 seconds.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the trigger delay time. 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_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 Source 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_spreading_long_code_mask(selector_string, value)

Sets the long code mask for reverse link spreading.

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 (int) – Specifies the long code mask for reverse link spreading.

Returns:

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

Return type:

int

set_walsh_code_length(selector_string, value)

Sets the Walsh code length of a specific user-defined channel. This value is expressed in chips. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to configure or read this attribute.

The default value is 64.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the Walsh code length of a specific user-defined channel. This value is expressed in chips. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Returns:

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

Return type:

int

set_walsh_code_number(selector_string, value)

Sets the Walsh code number of a specific user-defined channel. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the Walsh code number of a specific user-defined channel. This attribute is used only when you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined.

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 of seconds for all the measurements to complete.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of result name. Examples:

””

”signal::sig1”

”result::r1”

”signal::sig1/result::r1”

You can use the build_result_string() method to build the selector string.
timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

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

Return type:

int