ComponentCarrier

class nirfmxlte.component_carrier.ComponentCarrier(signal_obj)[source]

Bases: object

configure(selector_string, component_carrier_bandwidth, component_carrier_frequency, cell_id)[source]

Configures the Component Carrier Bandwidth, Component Carrier Frequency, and Cell ID of the component carrier.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

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

component_carrier_bandwidth (float) –

This parameter specifies the channel bandwidths of the signal being measured. The default value is 10.0 M.

Name (Value)	Description
200.0 k (2e5)	Indicates a channel bandwidth of 200 kHz. This value indicates that the received signal is an NB-IoT stand-alone signal.
1.4 M (1.4e6)	Indicates a channel bandwidth of 1.4 MHz.
3.0 M (3e6)	Indicates a channel bandwidth of 3 MHz.
5.0 M (5e6)	Indicates a channel bandwidth of 5 MHz.
10.0 M (10e6)	Indicates a channel bandwidth of 10 MHz.
15.0 M (15e6)	Indicates a channel bandwidth of 15 MHz.
20.0 M (20e6)	Indicates a channel bandwidth of 20 MHz.

component_carrier_frequency (float) – This parameter specifies the offsets of the component carrier from the subblock center frequency that you configure in the CENTER_FREQUENCY attribute. This parameter is applicable only if you set the COMPONENT_CARRIER_SPACING_TYPE attribute to User. The default value is 0.
cell_id (int) – This parameter specifies the physical layer cell identities. The default value is 0. Valid values are 0 to 503, inclusive.

Returns:

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

Return type:

int

configure_array(selector_string, component_carrier_bandwidth, component_carrier_frequency, cell_id)[source]

Configures an array of bandwidths, carrier offset frequencies, and cell IDs of component carriers.

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

Parameters:

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

Example:

”subblock0”

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

component_carrier_bandwidth (float) –

This parameter specifies the array of channel bandwidths of the signal being measured. The default value is 10 M.

Name (Value)	Description
200.0 k (2e5)	Indicates a channel bandwidth of 200 kHz. This value indicates that the received signal is an NB-IoT stand-alone signal.
1.4 M (1.4e6)	Indicates a channel bandwidth of 1.4 MHz.
3.0 M (3e6)	Indicates a channel bandwidth of 3 MHz.
5.0 M (5e6)	Indicates a channel bandwidth of 5 MHz.
10.0 M (10e6)	Indicates a channel bandwidth of 10 MHz.
15.0 M (15e6)	Indicates a channel bandwidth of 15 MHz.
20.0 M (20e6)	Indicates a channel bandwidth of 20 MHz.

component_carrier_frequency (float) – This parameter specifies the array of offsets of the component carrier from the subblock center frequency that you configure in the CENTER_FREQUENCY attribute. This parameter is applicable only if you set the COMPONENT_CARRIER_SPACING_TYPE attribute to User. The default value is 0.
cell_id (int) – This parameter specifies the array of the physical layer cell identities. 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_auto_npusch_channel_detection_enabled(selector_string, auto_npusch_channel_detection_enabled)[source]

Configures whether the values of the NPUSCH_TONE_OFFSET, NPUSCH_NUMBER_OF_TONES, and NPUSCH_MODULATION_TYPE attributes for the NPUSCH channel are auto-detected by the measurement or specified by you.

Parameters:

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

auto_npusch_channel_detection_enabled (enums.AutoNPuschChannelDetectionEnabled, int) –

This parameter specifies whether the values of NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH Mod Type attributes are auto-detected by the measurement or specified by you. The default value is True.

Name (Value)	Description
False (0)	The measurement uses the values that you specify for the NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH ModType attributes.
True (1)	The measurement uses the values of the NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH Mod Type attributes that are auto-detected.

Returns:

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

Return type:

int

configure_auto_resource_block_detection_enabled(selector_string, auto_resource_block_detection_enabled)[source]

Configures whether the values of the PUSCH_MODULATION_TYPE, PUSCH_NUMBER_OF_RESOURCE_BLOCK_CLUSTERS, PUSCH_RESOURCE_BLOCK_OFFSET, and PUSCH_NUMBER_OF_RESOURCE_BLOCKS attributes are automatically detected by the measurement or if you specify the values of these attributes.

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

Parameters:

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

auto_resource_block_detection_enabled (enums.AutoResourceBlockDetectionEnabled, int) –

This parameter specifies whether the values of the PUSCH Mod Type, PUSCH Num Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes are automatically detected by the measurement or if you specify the values of these attributes. The default value is True.

Name (Value)	Description
False (0)	The values of the PUSCH Mod Type, PUSCH Num RB Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes that you specify are used for the measurement.
True (1)	The values of the PUSCH Mod Type, PUSCH Num RB Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes are detected automatically and used for the measurement.

Returns:

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

Return type:

int

configure_cell_specific_ratio(selector_string, cell_specific_ratio)[source]

Configures the cell specific ratio parameter.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

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

cell_specific_ratio (enums.DownlinkUserDefinedRatio, int) –

This parameter specifies the ratio P_b/P_afor the cell-specific ratio of one, two, or four cell-specific antenna ports as described in Table 5.2-1 in section 5.2 of the 3GPP TS 36.213 Specifications. This parameter determines the power of the channel resource element (RE) in the symbols that do not contain the reference symbols. The default value is P_B=0.

Name (Value)	Description
P_B=0 (0)	Specifies a ratio of 1 for one antenna port and 5/4 for two or four antenna ports.
P_B=1 (1)	Specifies a ratio of 4/5 for one antenna port and 1 for two or four antenna ports.
P_B=2 (2)	Specifies a ratio of 3/5 for one antenna port and 3/4 for two or four antenna ports.
P_B=3 (3)	Specifies a ratio of 2/5 for one antenna port and 1/2 for two or four antenna ports.

Returns:

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

Return type:

int

configure_downlink_auto_cell_id_detection_enabled(selector_string, auto_cell_id_detection_enabled)[source]

Configures whether the cell ID is configured by the user or auto-detected by the measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
auto_cell_id_detection_enabled (enums.DownlinkAutoCellIDDetectionEnabled, int) –
This parameter specifies whether to enable autodetection the of cell ID. If signal being measured does not contain primary and secondary sync signal (PSS/SSS), autodetection of the cell ID is not possible. The default value is True.

Name (Value)

Description

False (0)

The measurement uses the cell ID you configure.

True (1)

The measurement auto detects the cell ID.

Returns:

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

Return type:

int

configure_downlink_auto_channel_detection(selector_string, auto_pdsch_channel_detection_enabled, auto_control_channel_power_detection_enabled, auto_pcfich_cfi_detection_enabled)[source]

Configures whether the values of physical downlink shared channel (PDSCH) parameters, control channel signal powers, and physical control format indicator channel (PCFICH) CFI are configured by a user or auto-detected by the measurement. The measurement ignores this method, when you set the LINK_DIRECTION attribute to Uplink.

Parameters:

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

auto_pdsch_channel_detection_enabled (enums.AutoPdschChannelDetectionEnabled, int) –

This parameter specifies whether the values of the PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding PDSCH_CW0_MODULATION_TYPE attribute, and the PDSCH_POWER attribute are auto-detected by the measurement or user-specified.

This parameter is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model.

Name (Value)	Description
False (0)	The value of the PDSCH RB Allocation attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute that you specify are used for the measurement.
True (1)	The value of the PDSCH RB Allocation attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute are auto-detected and used for the measurement.

auto_control_channel_power_detection_enabled (enums.AutoControlChannelPowerDetectionEnabled, int) –

This parameter specifies whether the value of PSS_POWER, SSS_POWER, PBCH_POWER, PDCCH_POWER, and PCFICH_POWER attributes are auto-detected by the measurement or user-specified. Currently, auto-detection of PHICH_POWER attribute is not supported.

This parameter is not valid, when you set the DL Ch Configuration Mode attribute to Test Model.

Name (Value)	Description
False (0)	The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, PHICH Power, and PCFICH Power attributes that you specify are used for the measurement.
True (1)	The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, and PCFICH Power attributes are auto-detected and used for the measurement.

auto_pcfich_cfi_detection_enabled (enums.AutoPcfichCfiDetectionEnabled, int) –

This parameter specifies whether the value of PCFICH_CFI attribute is auto-detected by the measurement or user-specified.

This parameter is not valid, when you set the DL Ch Configuration Mode attribute to Test Model.

Name (Value)	Description
False (0)	The value of PCFICH CFI attribute that you specify is used for the measurement.
True (1)	The value of PCFICH CFI attribute is auto-detected and used for the measurement. This value is obtained by decoding the PCFICH channel.

Returns:

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

Return type:

int

configure_downlink_channel_configuration_mode(selector_string, channel_configuration_mode)[source]

Configures the downlink channel configuration mode.

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.DownlinkChannelConfigurationMode, int) –

This parameter specifies the channel configuration mode. The default value is Test Model.

Name (Value)	Description
User Defined (1)	You have to manually set all the signals and channels.
Test Model (2)	You need to select a test model that will configure all the signals and channels automatically according to the 3GPP Specifications.

Returns:

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

Return type:

int

configure_downlink_number_of_subframes(selector_string, number_of_subframes)[source]

Configures the number of unique subframes that are transmitted from the DUT.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
number_of_subframes (int) – This parameter specifies the number of subframes to be configured. If you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model, this parameter will be set to 10 for FDD and 20 for TDD by default. The default value is 10. Valid values are 10 to 20, inclusive.

Returns:

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

Return type:

int

configure_downlink_synchronization_signal(selector_string, pss_power, sss_power)[source]

Configures the synchronization signal power relative to the cell-specific reference signal.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
pss_power (float) – This parameter specifies the power of the primary synchronization signal (PSS) relative to the power of the cell-specific reference signal. This value is expressed in dB. The default value is 0.
sss_power (float) – This parameter specifies the power of the secondary synchronization signal (SSS) relative to the power of the cell-specific reference signal. This value is expressed in dB. 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_downlink_test_model(selector_string, downlink_test_model)[source]

Configures the EUTRA test model type.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

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

downlink_test_model (enums.DownlinkTestModel, int) –

This parameter specifies the EUTRA test model type when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. Refer to section 6.1.1 of the 3GPP 36.141 specification for more information regarding test model configurations. The default value is TM1.1.

Name (Value)	Description
TM1.1 (0)	Specifies an E-UTRA Test Model 1.1.
TM1.2 (1)	Specifies an E-UTRA Test Model 1.2.
TM2 (2)	Specifies an E-UTRA Test Model 2.
TM2a (3)	Specifies an E-UTRA Test Model 2a.
TM2b (8)	Specifies an E-UTRA Test Model 2b.
TM3.1 (4)	Specifies an E-UTRA Test Model 3.1.
TM3.1a (7)	Specifies an E-UTRA Test Model 3.1a.
TM3.1b (9)	Specifies an E-UTRA Test Model 3.1b.
TM3.2 (5)	Specifies an E-UTRA Test Model 3.2.
TM3.3 (6)	Specifies an E-UTRA Test Model 3.3.

Returns:

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

Return type:

int

configure_downlink_test_model_array(selector_string, downlink_test_model)[source]

Configures an array of the EUTRA test model type for each component carrier within the subblock.

Parameters:

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

Example:

”subblock0”

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

downlink_test_model (enums.DownlinkTestModel, int) –

This parameter specifies the array of EUTRA test model types when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. Refer to section 6.1.1 of the 3GPP 36.141 specification for more information regarding test model configurations. The default value is TM1.1.

Name (Value)	Description
TM1.1 (0)	Specifies an E-UTRA Test Model 1.1.
TM1.2 (1)	Specifies an E-UTRA Test Model 1.2.
TM2 (2)	Specifies an E-UTRA Test Model 2.
TM2a (3)	Specifies an E-UTRA Test Model 2a.
TM2b (8)	Specifies an E-UTRA Test Model 2b.
TM3.1 (4)	Specifies an E-UTRA Test Model 3.1.
TM3.1a (7)	Specifies an E-UTRA Test Model 3.1a.
TM3.1b (9)	Specifies an E-UTRA Test Model 3.1b.
TM3.2 (5)	Specifies an E-UTRA Test Model 3.2.
TM3.3 (6)	Specifies an E-UTRA Test Model 3.3.

Returns:

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

Return type:

int

configure_emtc_analysis_enabled(selector_string, emtc_analysis_enabled)[source]

Configures whether the component carrier contains an enhanced machine type communications (Cat-M1 or Cat-M2) transmission.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

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

emtc_analysis_enabled (enums.EmtcAnalysisEnabled, int) –

This parameter specifies whether the component carrier contains an eMTC transmission. The default value is False.

Name (Value)	Description
False (0)	The measurement considers the signal as LTE FDD/TDD transmission.
True (1)	Detects the eMTC half duplex pattern, narrow band hopping, and eMTC guard symbols present in the uplink transmission.

Returns:

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

Return type:

int

configure_nb_iot_component_carrier(selector_string, n_cell_id, uplink_subcarrier_spacing)[source]

Configures the Ncell ID and Uplink Subcarrier Spacing parameters for the NB-IoT signal.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
n_cell_id (int) – This parameter specifies the narrowband physical layer cell identity. The default value is 0. Valid values are 0 to 503, inclusive.
uplink_subcarrier_spacing (enums.NBIoTUplinkSubcarrierSpacing, int) –
This parameter specifies the subcarrier bandwidth of an NB-IoT signal. This parameter specifies the spacing between adjacent subcarriers. The default value is 15 kHz.

Name (Value)

Description

15 kHz (0)

The subcarrier spacing is 15 kHz.

3.75 kHz (1)

The subcarrier spacing is 3.75 kHz.

Returns:

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

Return type:

int

configure_npusch_dmrs(selector_string, npusch_dmrs_base_sequence_mode, npusch_dmrs_base_sequence_index, npusch_dmrs_cyclic_shift, npusch_dmrs_group_hopping_enabled, npusch_dmrs_delta_ss)[source]

Configures the base sequence mode, base sequence index, cyclic shift, delta sequence shift of the narrowband physical uplink shared channel (NPUSCH) DMRS and specifies whether group hopping is enabled.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

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

npusch_dmrs_base_sequence_mode (enums.NPuschDmrsBaseSequenceMode, int) –

This parameter specifies whether the NPUSCH DMRS Base Sequence index is computed by the measurement or user-specified. This parameter is valid when you set the NPUSCH DMRS Group Hopping Enabled parameter to False, the value of NPUSCH_FORMAT attribute to 1, and the value of NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

The default value is Auto.

Name (Value)	Description
Manual (0)	The measurement uses the value that you specify for the NPUSCH DMRS Base Sequence Index parameter.
Auto (1)	The measurement uses the value of NCell ID attribute to compute the NPUSCH DMRS Base Sequence Index as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification.

npusch_dmrs_base_sequence_index (int) –
This parameter specifies the base sequence index of the NPUSCH DMRS as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification. This parameter is valid when you set the NPUSCH DMRS Group Hopping Enabled parameter to False, the NPUSCH DMRS Base Sequence Mode parameter to Manual, and the value of NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

The default value is 0.
- For 3 tones, valid values are 0 to 11, inclusive.
- For 6 tones, valid values are 0 to 13, inclusive.
- For 12 tones, valid values are 0 to 29, inclusive.
npusch_dmrs_cyclic_shift (int) –
This parameter specifies the cyclic shift of the NPUSCH DMRS as defined in table 10.1.4.1.2-3 of the 3GPP TS 36.211 specification.

This parameter is valid when you set the value of NPUSCH_NUMBER_OF_TONES attribute to 3 or 6. If the value of NPUSCH Num Tones attribute is 12, the NPUSCH DMRS Cyclic Shift parameter has a fixed value of 0.

The default value is 0.
- For 3 tones, valid values are 0 to 2, inclusive.
- For 6 tones, valid values are 0 to 3, inclusive.

npusch_dmrs_group_hopping_enabled (enums.NPuschDmrsGroupHoppingEnabled, int) –

This parameter specifies whether group hopping is enabled for the NPUSCH DMRS. This parameter is valid when the value of NPUSCH_FORMAT is equal to 1.

The default value is False.

Name (Value)	Description
False (0)	Group hopping is disabled.
True (1)	Group hopping is enabled. The sequence group number is calculated as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification

npusch_dmrs_delta_ss (int) – This parameter specifies the delta sequence shift of the NPUSCH DMRS that is used to calculate the sequence shift pattern, which in turn is used to compute the sequence group number as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification. This parameter is valid when you set the NPUSCH DMRS Group Hopping Enabled parameter to True. The default value is 0. Valid values are 0 to 29, inclusive.

Returns:

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

Return type:

int

configure_npusch_format(selector_string, format)[source]

Configures the format of the narrowband physical uplink shared channel (NPUSCH).

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
format (int) – This parameter specifies the NPUSCH format. A value of 1 indicates that NPUSCH carries user data (UL-SCH) and a value of 2 indicates, NPUSCH carries uplink control information. The default value is 1.

Returns:

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

Return type:

int

configure_npusch_starting_slot(selector_string, starting_slot)[source]

Configures the starting slot of the NPUSCH burst.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
starting_slot (int) – This parameter specifies the starting slot number of the NPUSCH burst. 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_npusch_tones(selector_string, tone_offset, number_of_tones, modulation_type)[source]

Configures the values of Tone Offset, Number of Tones, and Modulation Type parameters for NPUSCH channel.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
tone_offset (int) –
This parameter specifies the location of the starting subcarrier (tone) within the 200 kHz bandwidth that is allocated to the NPUSCH channel. The default value is 0.

For 15 kHz subcarrier spacing, the valid values are as follows:
- for 1 tones, 0 to 11, inclusive
- for 3 tones, 0, 3, 6, and 9
- for 6 tones, 0 and 6
- for 12 tones, 0
For 3.75 kHz subcarrier spacing, the valid values are 0 to 47, inclusive.
number_of_tones (int) –
This parameter specifies the number of subcarriers (tones) within the 200 kHz bandwidth that is allocated to the NPUSCH channel.

The default value is 1.

For Format 1 and 15 kHz subcarrier spacing, the valid values are 1, 3, 6, and 12.

For Format 1, 3.75 kHz subcarrier spacing, and Format 2, the valid value is 1.
modulation_type (enums.NPuschModulationType, int) –
This parameter specifies the modulation type that is used by the NPUSCH channel. The default value is BPSK.

This parameter is valid when Number of Tones is equal to 1 and NPUSCH_FORMAT is equal to 1. The modulation type for other configurations is defined in Table 10.1.3.2-1 of the 3GPP TS 36.211 specification.

Name (Value)

Description

BPSK (0)

Specifies a BPSK modulation scheme.

QPSK (1)

Specifies a QPSK modulation scheme.

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_pdsch_channels(selector_string, number_of_pdsch_channels)[source]

Configures the number of different physical downlink shared channel (PDSCH) allocations in a subframe.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number, carrier number, and subframe number.

Example:

”subblock0/carrier0/subframe0”

You can use the build_subframe_string() method to build the selector string.
number_of_pdsch_channels (int) – This parameter specifies the number of PDSCH allocations in a subframe. The default value is 1. Valid values are 0 to 100, inclusive.

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_pusch_resource_block_clusters(selector_string, number_of_resource_block_clusters)[source]

Configures the number of clusters of resource allocations.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
number_of_resource_block_clusters (int) – This parameter specifies the number resource allocation clusters, with each cluster including one or more consecutive resource blocks. For more information about the physical uplink shared channel (PUSCH) number of clusters, refer to 5.5.2.1.1 of the 3GPP TS 36.213 specification. The default value is 1.

Returns:

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

Return type:

int

configure_pbch(selector_string, pbch_power)[source]

Configures the power of physical broadcast channel (PBCH) power relative to the cell-specific reference signal.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
pbch_power (float) – This parameter specifies the power of the PBCH relative to the power of the cell-specific reference signal. This value is expressed in dB. 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_pcfich(selector_string, cfi, power)[source]

Configures the CFI and Power parameters of the physical control format indicator channel (PCFICH).

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number, carrier number, and subframe number.

Example:

”subblock0/carrier0/subframe0”

You can use the build_subframe_string() method to build the selector string.
cfi (int) – This parameter specifies the control format indicator (CFI) carried by PCFICH. CFI is used to compute the number of OFDM symbols which will determine the size of physical downlink control channel (PDCCH) within a subframe. The default value is 1.
power (float) – This parameter specifies the power of the PCFICH relative to the power of the cell-specific reference signal. This value is expressed in dB. 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_pdcch(selector_string, pdcch_power)[source]

Configures the physical downlink control channel (PDCCH) power relative to the cell-specific reference signal.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
pdcch_power (float) – This parameter specifies the power of the PDCCH relative to the power of the cell-specific reference signal. This value is expressed in dB. 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_pdsch(selector_string, cw0_modulation_type, resource_block_allocation, power)[source]

Configures the codeword0 modulation type, resource block, and relative power of a physical downlink shared channel (PDSCH) allocation.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number, carrier number, subframe number, and PDSCH number.

Example:

”subblock0/carrier0/subframe0/PDSCH0”

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

cw0_modulation_type (enums.UserDefinedPdschCW0ModulationType, int) –

This parameter specifies the modulation type of Codeword0 PDSCH allocation. The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.
256 QAM (3)	Specifies a 256-QAM modulation scheme.
1024 QAM (4)	Specifies a 1024-QAM modulation scheme.

resource_block_allocation (string) –
This parameter specifies the resource blocks of the PDSCH allocation. The default value is 0 - 49.

The following string formats are supported for this parameter:

1) RB _StartValue1-RB _StopValue1,*RB* _StartValue2-RB _StopValue2

2) RB ₁,*RB* ₂

3) RB _StartValue1-RB _StopValue1, RB ₁,*RB* _StartValue2-RB _StopValue2,*RB* ₂

For example: If the RB allocation is 0-5,7,8,10-15, the RB allocation string specifies contiguous resource blocks from 0 to 5, resource block 7, resource block 8, and contiguous resource blocks from 10 to 15.
power (float) – This parameter specifies the PDSCH power level (P_a) relative to the power of the cell-specific reference signal. This value is expressed in dB. Measurement uses the DOWNLINK_USER_DEFINED_CELL_SPECIFIC_RATIO attribute to calculate P_b. Refer to section 3.3 of the 3GPP 36.521 specifications for more information about P_a. 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_phich(selector_string, resource, duration, power)[source]

Configures the Resource, Duration, and Power parameters of the physical hybrid-ARQ indicator channel (PHICH).

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number, carrier number, and subframe number.

Example:

”subblock0/carrier0/subframe0”

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

resource (enums.DownlinkUserDefinedPhichResource, int) –

This parameter specifies the PHICH resource value. This value is expressed in Ng. This parameter is used to calculate number of PHICH resource groups. Refer to section 6.9 of the 3GPP 36.211 specification for more information about PHICH. The default value is 1/6.

Name (Value)	Description
1/6 (0)	Specifies that the PHICH resource value is 1/6.
1/2 (1)	Specifies that the PHICH resource value is 1/2.
1 (2)	Specifies that the PHICH resource value is 1.
2 (3)	Specifies that the PHICH resource value is 2.

duration (enums.DownlinkUserDefinedPhichDuration, int) –
This parameter specifies the PHICH duration. The default value is Normal.

Name (Value)

Description

Normal (0)

Orthogonal sequences of length 4 is used to extract PHICH.
power (float) – This parameter specifies the power of all BPSK symbols in a PHICH sequence. This value is expressed in dB. 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_pssch_modulation_type(selector_string, modulation_type)[source]

Configures the modulation scheme used in the physical sidelink shared channel (PSSCH) of the signal being measured.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
modulation_type (enums.PsschModulationType, int) –
This parameter specifies the modulation scheme used in the PSSCH channel of the signal being measured. The default value is QPSK.

Name (Value)

Description

QPSK (0)

Specifies a QPSK modulation scheme.

16 QAM (1)

Specifies a 16-QAM modulation scheme.

64 QAM (2)

Specifies a 64-QAM modulation scheme.

Returns:

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

Return type:

int

configure_pssch_resource_blocks(selector_string, resource_block_offset, number_of_resource_blocks)[source]

Configures the start and number of resource blocks allocated for the physical sidelink shared channel (PSSCH) allocation.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

You can use the build_carrier_string() method to build the selector string.
resource_block_offset (int) – This parameter specifies the starting resource block number of the PSSCH allocation. The default value is 0.
number_of_resource_blocks (int) – This parameter specifies the number of consecutive resource blocks in the PSSCH allocation. The default value is -1. If you set this parameter to -1, all available resource blocks for the specified bandwidth are configured.

Returns:

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

Return type:

int

configure_pusch_modulation_type(selector_string, modulation_type)[source]

Configures the modulation scheme used in the physical uplink shared channel (PUSCH) channel of the signal being measured.

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

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of subblock number and carrier number. The default value is “subblock0/carrier0”.

Example:

”subblock0/carrier0”

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

modulation_type (enums.PuschModulationType, int) –

This parameter specifies the modulation scheme used in the PUSCH channel of the signal being measured. The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.
256 QAM (3)	Specifies a 256-QAM modulation scheme.
1024 QAM (4)	Specifies a 1024-QAM modulation scheme.

Returns:

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

Return type:

int

configure_pusch_resource_blocks(selector_string, resource_block_offset, number_of_resource_blocks)[source]

Configures the start and number of resource blocks allocated for the physical uplink shared channel (PUSCH) cluster.

Use “cluster<l>” or “carrier<k>” or “subblock<n>/carrier<k>/cluster<l>” as the selector string to configure this result.

Parameters:

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

Example:

”subblock0/carrier0/cluster0”

You can use the build_cluster_string() method to build the selector string.
resource_block_offset (int) – This parameter specifies the starting resource block number of a PUSCH cluster. The default value is 0.
number_of_resource_blocks (int) – This parameter specifies the number of consecutive resource blocks in a PUSCH cluster. The default value is -1. If you set this parameter to -1, all available resource blocks for the specified bandwidth are configured.

Returns:

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

Return type:

int

configure_spacing(selector_string, component_carrier_spacing_type, component_carrier_at_center_frequency)[source]

Configures the Component Carrier Spacing Type and Component Carrier at Center Frequency parameters, which help to set the spacing between adjacent component carriers within a subblock.

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

Refer to the Channel Spacing and Carrier Frequency Offset Definition and Reference Frequency topics for more information about carrier spacing.

Parameters:

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

Example:

”subblock0”

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

component_carrier_spacing_type (enums.ComponentCarrierSpacingType, int) –

This parameter specifies the spacing between the two adjacent component carriers within a subblock. The default value is Nominal.

Name (Value)	Description
Nominal (0)	Calculates the frequency spacing between component carriers as defined in section 5.4.1A of the 3GPP TS 36.521 specification, and sets the CC Freq attribute.
Minimum (1)	Calculates the frequency spacing between component carriers as defined in section 5.4.1A of the 3GPP TS 36.521 specification, and sets the CC Freq attribute.
User (2)	The CC frequency that you configure in the CC Freq attribute is used.

component_carrier_at_center_frequency (int) – This parameter specifies the index of the component carrier having its center at the user-configured center frequency. RFmxLTE uses this parameter along with the CC Spacing Type attribute to calculate the component carrier frequency. The default value is -1. If the value is -1, the CC frequency values are calculated such that the center of aggregated carriers (subblock) lies at the subblock center frequency. This parameter is ignored if you set the Component Carrier Spacing Type parameter to User.

Returns:

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

Return type:

int

get_auto_control_channel_power_detection_enabled(selector_string)[source]

Gets whether the value of PSS_POWER, SSS_POWER, PBCH_POWER, PDCCH_POWER, and PCFICH_POWER attributes are auto-detected by the measurement or user-specified. Currently, auto-detection of PHICH_POWER attribute is not supported. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

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

The default value is True.

Name (Value)	Description
False (0)	The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, PHICH Power, and PCFICH Power attributes that you specify are used for the measurement.
True (1)	The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, and PCFICH Power attributes are auto-detected and used for the measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoControlChannelPowerDetectionEnabled):: Specifies whether the value of PSS_POWER, SSS_POWER, PBCH_POWER, PDCCH_POWER, and PCFICH_POWER attributes are auto-detected by the measurement or user-specified. Currently, auto-detection of PHICH_POWER attribute is not supported. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_npusch_channel_detection_enabled(selector_string)[source]

Gets whether the values of the NPUSCH_TONE_OFFSET, NPUSCH_NUMBER_OF_TONES, and NPUSCH_MODULATION_TYPE attributes are auto-detected by the measurement or specified by you.

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

Name (Value)	Description
False (0)	The measurement uses the values that you specify for the NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH Mod Type attributes.
True (1)	The measurement uses the values of the NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH Mod Type attributes that are auto-detected.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoNPuschChannelDetectionEnabled):: Specifies whether the values of the NPUSCH_TONE_OFFSET, NPUSCH_NUMBER_OF_TONES, and NPUSCH_MODULATION_TYPE attributes are auto-detected by the measurement or specified by you.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_pcfich_cfi_detection_enabled(selector_string)[source]

Gets whether the value of PCFICH_CFI attribute is auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

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

The default value is True.

Name (Value)	Description
False (0)	The value of PCFICH CFI attribute used for the measurement is specified by you.
True (1)	The value of PCFICH CFI attribute used for the measurement is auto-detected. This value is obtained by decoding the PCFICH channel.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoPcfichCfiDetectionEnabled):: Specifies whether the value of PCFICH_CFI attribute is auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_pdsch_channel_detection_enabled(selector_string)[source]

Gets whether the values of the PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding PDSCH_CW0_MODULATION_TYPE attribute, and the PDSCH_POWER attribute are auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the values of the PDSCH RB Allocation attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute that you specify.
True (1)	The measurement uses the values of the PDSCH RB Allocation attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute that are auto-detected.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoPdschChannelDetectionEnabled):: Specifies whether the values of the PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding PDSCH_CW0_MODULATION_TYPE attribute, and the PDSCH_POWER attribute are auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_resource_block_detection_enabled(selector_string)[source]

Gets whether the values of the PUSCH_MODULATION_TYPE, PUSCH_NUMBER_OF_RESOURCE_BLOCK_CLUSTERS, PUSCH_RESOURCE_BLOCK_OFFSET, and PUSCH_NUMBER_OF_RESOURCE_BLOCKS attributes are auto-detected by the measurement or if you specify the values of these attributes.

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

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

The default value is True.

Name (Value)	Description
False (0)	The values of the PUSCH Mod Type, PUSCH Num Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes that you specify are used for the measurement.
True (1)	The values of the PUSCH Mod Type, PUSCH Num Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes are detected automatically and used for the measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoResourceBlockDetectionEnabled):: Specifies whether the values of the PUSCH_MODULATION_TYPE, PUSCH_NUMBER_OF_RESOURCE_BLOCK_CLUSTERS, PUSCH_RESOURCE_BLOCK_OFFSET, and PUSCH_NUMBER_OF_RESOURCE_BLOCKS attributes are auto-detected by the measurement or if you specify the values of these attributes.
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_bandwidth(selector_string)[source]

Gets the channel bandwidth of the signal being measured. This value is expressed in Hz.

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

The default value is 10 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the channel bandwidth of the signal being measured. 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_cell_id(selector_string)[source]

Gets a physical layer cell identity.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies a physical layer cell identity.
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_component_carrier_at_center_frequency(selector_string)[source]

Gets the index of the component carrier having its center at the user-configured center frequency. RFmx LTE uses this attribute along with COMPONENT_CARRIER_SPACING_TYPE attribute to calculate the value of the COMPONENT_CARRIER_FREQUENCY.

Refer to the Carrier Frequency Offset Definition and Reference Frequency topic for more information about component carrier frequency.

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

Valid values are -1, 0, 1 … n - 1, inclusive, where n is the number of component carriers in the subblock.

The default value is -1. If the value is -1, the component carrier frequency values are calculated such that the center of aggregated carriers (subblock) lies at the Center Frequency. This attribute is ignored if you set the CC Spacing Type attribute to User.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the index of the component carrier having its center at the user-configured center frequency. RFmx LTE uses this attribute along with COMPONENT_CARRIER_SPACING_TYPE attribute to calculate the value of the COMPONENT_CARRIER_FREQUENCY.
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_cyclic_prefix_mode(selector_string)[source]

Gets the cyclic prefix (CP) duration and the number of symbols in a slot for the signal being measured.

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

The default value is Normal.

Name (Value)	Description
Normal (0)	The CP duration is 4.67 microseconds, and the number of symbols in a slot is 7.
Extended (1)	The CP duration is 16.67 microseconds, and the number of symbols in a slot is 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CyclicPrefixMode):: Specifies the cyclic prefix (CP) duration and the number of symbols in a slot for the signal being measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_dmrs_occ_enabled(selector_string)[source]

Gets whether orthogonal cover codes (OCCs) need to be used on the demodulation reference signal (DMRS) signal. The measurement internally sets this attribute to TRUE for multi antenna cases.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement ignores the Cyclic Shift Field and uses the PUSCH n_DMRS_2 field for DMRS calculations.
True (1)	The measurement uses the table 5.5.2.1.1-1 of 3GPP 36.211 specification to decide the value of PUSCH n_DMRS_2 and [w(0) w(1)] for DMRS signal based on the values you set for the Cyclic Shift Field and Tx Antenna to Analyze.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DmrsOccEnabled):: Specifies whether orthogonal cover codes (OCCs) need to be used on the demodulation reference signal (DMRS) signal. The measurement internally sets this attribute to TRUE for multi antenna cases.
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_auto_cell_id_detection_enabled(selector_string)[source]

Gets whether to enable autodetection of the cell ID. If the signal being measured does not contain primary and secondary sync signal (PSS/SSS), autodetection of cell ID is not possible. Detected cell ID can be fetched using MODACC_RESULTS_DOWNLINK_DETECTED_CELL_ID attribute.

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

Name (Value)	Description
False (0)	The measurement uses the cell ID you configure.
True (1)	The measurement auto detects the cell ID.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DownlinkAutoCellIDDetectionEnabled):: Specifies whether to enable autodetection of the cell ID. If the signal being measured does not contain primary and secondary sync signal (PSS/SSS), autodetection of cell ID is not possible. Detected cell ID can be fetched using MODACC_RESULTS_DOWNLINK_DETECTED_CELL_ID attribute.
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_channel_configuration_mode(selector_string)[source]

Gets the channel configuration mode.

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

Name (Value)	Description
User Defined (1)	You have to manually set all the signals and channels.
Test Model (2)	You need to select a test model using the DL Test Model attribute, which will configure all the signals and channels automatically according to the 3GPP specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DownlinkChannelConfigurationMode):: Specifies the channel configuration mode.
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_number_of_subframes(selector_string)[source]

Gets the number of unique subframes transmitted by the DUT. If you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model, this attribute will be set to 10 for FDD and 20 for TDD by default.

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

The default value is 10. Valid values are 10 and 20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of unique subframes transmitted by the DUT. If you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model, this attribute will be set to 10 for FDD and 20 for TDD by default.
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_test_model(selector_string)[source]

Gets the E-UTRA test model type when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. Refer to section 6.1.1 of the 3GPP 36.141 specification for more information regarding test model configurations.

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

The default value is TM1.1.

Name (Value)	Description
TM1.1 (0)	Specifies an E-UTRA Test Model 1.1.
TM1.2 (1)	Specifies an E-UTRA Test Model 1.2.
TM2 (2)	Specifies an E-UTRA Test Model 2.
TM2a (3)	Specifies an E-UTRA Test Model 2a.
TM2b (8)	Specifies an E-UTRA Test Model 2b.
TM3.1 (4)	Specifies an E-UTRA Test Model 3.1.
TM3.1a (7)	Specifies an E-UTRA Test Model 3.1a.
TM3.1b (9)	Specifies an E-UTRA Test Model 3.1b.
TM3.2 (5)	Specifies an E-UTRA Test Model 3.2.
TM3.3 (6)	Specifies an E-UTRA Test Model 3.3.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DownlinkTestModel):: Specifies the E-UTRA test model type when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. Refer to section 6.1.1 of the 3GPP 36.141 specification for more information regarding test model configurations.
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_user_defined_cell_specific_ratio(selector_string)[source]

Gets the ratio Rho_b/Rho_afor the cell-specific ratio of one, two, or four cell-specific antenna ports as described in Table 5.2-1 in section 5.2 of the 3GPP TS 36.213 specification. This attribute determines the power of the channel resource element (RE) in the symbols that do not contain the reference symbols.

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

The default value is P_B=0.

Name (Value)	Description
P_B=0 (0)	Specifies a ratio of 1 for one antenna port and 5/4 for two or four antenna ports.
P_B=1 (1)	Specifies a ratio of 4/5 for one antenna port and 1 for two or four antenna ports.
P_B=2 (2)	Specifies a ratio of 3/5 for one antenna port and 3/4 for two or four antenna ports.
P_B=3 (3)	Specifies a ratio of 2/5 for one antenna port and 1/2 for two or four antenna ports.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DownlinkUserDefinedRatio):: Specifies the ratio Rho_b/Rho_afor the cell-specific ratio of one, two, or four cell-specific antenna ports as described in Table 5.2-1 in section 5.2 of the 3GPP TS 36.213 specification. This attribute determines the power of the channel resource element (RE) in the symbols that do not contain the reference symbols.
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_emtc_analysis_enabled(selector_string)[source]

Gets whether the component carrier contains enhanced machine type communications (Cat-M1 or Cat-M2) transmission.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement considers the signal as LTE FDD/TDD transmission.
True (1)	Detects the eMTC half duplex pattern, narrow band hopping, and eMTC guard symbols present in the uplink transmission.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.EmtcAnalysisEnabled):: Specifies whether the component carrier contains enhanced machine type communications (Cat-M1 or Cat-M2) transmission.
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_frequency(selector_string)[source]

Gets the offset of the component carrier from the subblock center frequency that you configure in the CENTER_FREQUENCY attribute. This value is expressed in Hz. This attribute is valid only when you set the COMPONENT_CARRIER_SPACING_TYPE attribute to User.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the offset of the component carrier from the subblock center frequency that you configure in the CENTER_FREQUENCY attribute. This value is expressed in Hz. This attribute is valid only when you set the COMPONENT_CARRIER_SPACING_TYPE attribute to User.
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_laa_downlink_number_of_ending_symbols(selector_string)[source]

Gets the number of ending symbols in the last subframe of an LAA downlink burst. Refer to section 4.3 of the 3GPP 36.211 specification for more information regarding LAA downlink number of ending symbols.

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

The default value is 14.

Name (Value)	Description
3 (3)	The number of ending symbols in the last subframe of an LAA downlink burst is 3.
6 (6)	The number of ending symbols in the last subframe of an LAA downlink burst is 6.
9 (9)	The number of ending symbols in the last subframe of an LAA downlink burst is 9.
10 (10)	The number of ending symbols in the last subframe of an LAA downlink burst is 10.
11 (11)	The number of ending symbols in the last subframe of an LAA downlink burst is 11.
12 (12)	The number of ending symbols in the last subframe of an LAA downlink burst is 12.
14 (14)	The number of ending symbols in the last subframe of an LAA downlink burst is 14.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LaaDownlinkNumberOfEndingSymbols):: Specifies the number of ending symbols in the last subframe of an LAA downlink burst. Refer to section 4.3 of the 3GPP 36.211 specification for more information regarding LAA downlink number of ending symbols.
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_laa_downlink_starting_symbol(selector_string)[source]

Gets the starting symbol number in the first subframe of an LAA downlink burst. Refer to section 13A of the 3GPP 36.213 specification for more information regarding LAA downlink starting symbol.

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

The default value is 0.

Name (Value)	Description
0 (0)	The first subframe of an LAA downlink burst starts at symbol 0.
7 (7)	The first subframe of an LAA downlink burst starts at symbol 7.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LaaDownlinkStartingSymbol):: Specifies the starting symbol number in the first subframe of an LAA downlink burst. Refer to section 13A of the 3GPP 36.213 specification for more information regarding LAA downlink starting symbol.
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_laa_number_of_subframes(selector_string)[source]

Gets the number of subframes in an LAA burst including the starting subframe.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of subframes in an LAA burst including the starting subframe.
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_laa_starting_subframe(selector_string)[source]

Gets the starting subframe of an LAA burst.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 starting subframe of an LAA burst.
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_laa_uplink_ending_symbol(selector_string)[source]

Gets the ending symbol number in the last subframe of an LAA uplink burst. Refer to section 5.3.3.1.1A of the 3GPP 36.212 specification for more information regarding LAA uplink ending symbol.

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

The default value is 13.

Name (Value)	Description
12 (12)	The last subframe of an LAA uplink burst ends at symbol 12.
13 (13)	The last subframe of an LAA uplink burst ends at symbol 13.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LaaUplinkEndingSymbol):: Specifies the ending symbol number in the last subframe of an LAA uplink burst. Refer to section 5.3.3.1.1A of the 3GPP 36.212 specification for more information regarding LAA uplink ending symbol.
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_laa_uplink_start_position(selector_string)[source]

Gets the starting position of symbol 0 in the first subframe of an LAA uplink burst. Refer to section 5.6 of the 3GPP 36.211 specification for more information regarding LAA uplink start position.

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

The default value is 00.

Name (Value)	Description
00 (0)	The symbol 0 in the first subframe of an LAA uplink burst is completely occupied. There is no idle duration.
01 (1)	The starting position of symbol 0 in the first subframe of an LAA uplink burst is calculated as per section 5.6 (frame structure type 3) of the 3GPP 36.211 specification. The symbol is partially occupied.
10 (2)	The starting position of symbol 0 in the first subframe of an LAA uplink burst is calculated as per section 5.6 (frame structure type 3) of the 3GPP 36.211 specification. The symbol is partially occupied.
11 (3)	The symbol 0 in the first subframe of an LAA uplink burst is completely idle. Symbol 0 is not transmitted in this case.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LaaUplinkStartPosition):: Specifies the starting position of symbol 0 in the first subframe of an LAA uplink burst. Refer to section 5.6 of the 3GPP 36.211 specification for more information regarding LAA uplink start position.
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_n_cell_id(selector_string)[source]

Gets the narrowband physical layer cell identity.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the narrowband physical layer cell identity.
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_nb_iot_downlink_channel_configuration_mode(selector_string)[source]

Gets the downlink channel configuration mode for NB-IoT.

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

Name (Value)	Description
User Defined (1)	You have to manually set all the signals and channels.
Test Model (2)	Configures all the signals and channels automatically according to the 3GPP NB-IoT test model specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NBIoTDownlinkChannelConfigurationMode):: Specifies the downlink channel configuration mode for NB-IoT.
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_nb_iot_uplink_subcarrier_spacing(selector_string)[source]

Gets the subcarrier bandwidth of an NB-IoT signal. This attribute specifies the spacing between adjacent subcarriers.

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

The default value is 15 kHz.

Name (Value)	Description
15 kHz (0)	The subcarrier spacing is 15 kHz.
3.75 kHz (1)	The subcarrier spacing is 3.75 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NBIoTUplinkSubcarrierSpacing):: Specifies the subcarrier bandwidth of an NB-IoT signal. This attribute specifies the spacing between adjacent subcarriers.
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_npdsch_enabled(selector_string)[source]

Gets whether NPDSCH is active in a particular subframe. Note that in even-numbered frames, subframes 0, 5, and 9 are reserved for NPBCH, NPSS, and NSSS. In odd-numbered frames, subframes 10 and 15 are reserved for NPBCH and NPSS.The measurement will return an error if you try to configure NPDSCH for those subframes.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is False.

Name (Value)	Description
False (0)	Indicates to the measurement that NPDSCH is not present in a particular subframe.
True (1)	Indicates to the measurement that NPDSCH is present in a particular subframe.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NpdschEnabled):: Specifies whether NPDSCH is active in a particular subframe. Note that in even-numbered frames, subframes 0, 5, and 9 are reserved for NPBCH, NPSS, and NSSS. In odd-numbered frames, subframes 10 and 15 are reserved for NPBCH and NPSS.The measurement will return an error if you try to configure NPDSCH for those subframes.
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_npdsch_modulation_type(selector_string)[source]

Gets the modulation scheme used in NB-IoT physical downlink shared channel (NPDSCH) of the signal being measured.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NpdschModulationType):: Specifies the modulation scheme used in NB-IoT physical downlink shared channel (NPDSCH) of the signal being measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_npdsch_power(selector_string)[source]

Gets the NB-IoT physical downlink shared channel (NPDSCH) power level relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the NB-IoT physical downlink shared channel (NPDSCH) power level relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.
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_npss_power(selector_string)[source]

Gets the power of the NB-IoT primary synchronization signal (NPSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of the NB-IoT primary synchronization signal (NPSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.
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_npusch_dmrs_base_sequence_index(selector_string)[source]

Gets the base sequence index of the Narrowband Physical Uplink Shared Channel (NPUSCH) DMRS as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_DMRS_BASE_SEQUENCE_MODE attribute to Manual, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

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

The default value is 0.

For 3 tones, valid values are 0 to 11, inclusive.
For 6 tones, valid values are 0 to 13, inclusive.
For 12 tones, valid values are 0 to 29, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the base sequence index of the Narrowband Physical Uplink Shared Channel (NPUSCH) DMRS as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_DMRS_BASE_SEQUENCE_MODE attribute to Manual, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.
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_npusch_dmrs_base_sequence_mode(selector_string)[source]

Gets whether the NPUSCH_DMRS_BASE_SEQUENCE_INDEX attribute is computed by the measurement or specified by you. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_FORMAT attribute to 1, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

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

The default value is Auto.

Name (Value)	Description
Manual (0)	The measurement uses the value that you specify for the NPUSCH DMRS Base Sequence Index attribute.
Auto (1)	The measurement uses the value of NCell ID attribute to compute the NPUSCH DMRS Base Sequence Index as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NPuschDmrsBaseSequenceMode):: Specifies whether the NPUSCH_DMRS_BASE_SEQUENCE_INDEX attribute is computed by the measurement or specified by you. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_FORMAT attribute to 1, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.
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_npusch_dmrs_cyclic_shift(selector_string)[source]

Gets the cyclic shift of the narrowband physical uplink shared channel (NPUSCH) DMRS as defined in Table 10.1.4.1.2-3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_NUMBER_OF_TONES attribute to 3 or 6. If the value of NPUSCH Num Tones attribute is 12, the NPUSCH DMRS Cyclic Shift attribute has a fixed value of 0.

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

The default value is 0.

For 3 tones, valid values are 0 to 2, inclusive.
For 6 tones, valid values are 0 to 3, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the cyclic shift of the narrowband physical uplink shared channel (NPUSCH) DMRS as defined in Table 10.1.4.1.2-3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_NUMBER_OF_TONES attribute to 3 or 6. If the value of NPUSCH Num Tones attribute is 12, the NPUSCH DMRS Cyclic Shift attribute has a fixed value of 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_npusch_dmrs_delta_sequence_shift(selector_string)[source]

Gets the delta sequence shift of the narrowband physical uplink shared channel (NPUSCH) DMRS, which is used to calculate the sequence shift pattern. This value is used to compute the sequence group number as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to True.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the delta sequence shift of the narrowband physical uplink shared channel (NPUSCH) DMRS, which is used to calculate the sequence shift pattern. This value is used to compute the sequence group number as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to True.
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_npusch_dmrs_group_hopping_enabled(selector_string)[source]

Gets whether the group hopping is enabled for narrowband physical uplink shared channel (NPUSCH) DMRS. This attribute is valid only when the NPUSCH_FORMAT is 1.

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

The default value is False.

Name (Value)	Description
False (0)	Group hopping is disabled.
True (1)	Group hopping is enabled. The sequence group number is calculated as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NPuschDmrsGroupHoppingEnabled):: Specifies whether the group hopping is enabled for narrowband physical uplink shared channel (NPUSCH) DMRS. This attribute is valid only when the NPUSCH_FORMAT is 1.
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_npusch_format(selector_string)[source]

Gets the NPUSCH format. A value of 1 indicates that narrowband physical uplink shared channel (NPUSCH) carries user data (UL-SCH) and a value of 2 indicates that NPUSCH carries uplink control information.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the NPUSCH format. A value of 1 indicates that narrowband physical uplink shared channel (NPUSCH) carries user data (UL-SCH) and a value of 2 indicates that NPUSCH carries uplink control information.
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_npusch_modulation_type(selector_string)[source]

Gets the modulation type that is used by the narrowband physical uplink shared channel (NPUSCH). This attribute is valid when NPUSCH_NUMBER_OF_TONES is equal to 1 and NPUSCH_FORMAT is equal to 1. The modulation type for other configurations is defined in Table 10.1.3.2-1 of the 3GPP TS 36.211 specification.

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

The default value is BPSK.

Name (Value)	Description
BPSK (0)	Specifies a BPSK modulation scheme.
QPSK (1)	Specifies a QPSK modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.NPuschModulationType):: Specifies the modulation type that is used by the narrowband physical uplink shared channel (NPUSCH). This attribute is valid when NPUSCH_NUMBER_OF_TONES is equal to 1 and NPUSCH_FORMAT is equal to 1. The modulation type for other configurations is defined in Table 10.1.3.2-1 of the 3GPP TS 36.211 specification.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_npusch_number_of_tones(selector_string)[source]

Gets the number of subcarriers (tones) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).

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

The default value is 1.

For Format 1 and 15 kHz subcarrier spacing, the valid values are 1, 3, 6, and 12.

For Format 1, 3.75 kHz subcarrier spacing, and Format 2, the valid value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of subcarriers (tones) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).
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_npusch_starting_slot(selector_string)[source]

Gets the starting slot number of the NPUSCH burst.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 starting slot number of the NPUSCH burst.
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_npusch_tone_offset(selector_string)[source]

Gets the location of the starting subcarrier (tone) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).

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

The default value is 0.

For 15 kHz subcarrier spacing, the valid values are as follows:

for 1 tones, 0 to 11, inclusive
for 3 tones, 0, 3, 6, and 9
for 6 tones, 0 and 6
for 12 tones, 0

For 3.75 kHz subcarrier spacing, the valid values are 0 to 47, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the location of the starting subcarrier (tone) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).
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_nsss_power(selector_string)[source]

Gets the power of the NB-IoT secondary synchronization signal (NSSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of the NB-IoT secondary synchronization signal (NSSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.
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_component_carriers(selector_string)[source]

Gets the number of component carriers configured within a subblock.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of component carriers configured within a subblock.
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_pdsch_channels(selector_string)[source]

Gets the number of physical downlink shared channel (PDSCH) allocations in a subframe.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of physical downlink shared channel (PDSCH) allocations in a subframe.
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_pbch_power(selector_string)[source]

Gets the power of physical broadcast channel (PBCH) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of physical broadcast channel (PBCH) relative to the power of cell-specific reference signal. This value is expressed in dB.
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_pcfich_cfi(selector_string)[source]

Gets the control format indicator (CFI) carried by physical control format indicator channel (PCFICH). CFI is used to compute the number of OFDM symbols which will determine the size of physical downlink control channel (PDCCH) within a subframe.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the control format indicator (CFI) carried by physical control format indicator channel (PCFICH). CFI is used to compute the number of OFDM symbols which will determine the size of physical downlink control channel (PDCCH) within a subframe.
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_pcfich_power(selector_string)[source]

Gets the power of physical control format indicator channel (PCFICH) relative to the power of cell-specific reference signal. This value is expressed in dB.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of physical control format indicator channel (PCFICH) relative to the power of cell-specific reference signal. This value is expressed in dB.
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_pdcch_power(selector_string)[source]

Gets the power of physical downlink control channel (PDCCH) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of physical downlink control channel (PDCCH) relative to the power of cell-specific reference signal. This value is expressed in dB.
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_pdsch_cw_0_modulation_type(selector_string)[source]

Gets the modulation type of codeword0 PDSCH allocation.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure or read this attribute.

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.
256 QAM (3)	Specifies a 256-QAM modulation scheme.
1024 QAM (4)	Specifies a 1024-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.UserDefinedPdschCW0ModulationType):: Specifies the modulation type of codeword0 PDSCH allocation.
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_pdsch_power(selector_string)[source]

Gets the physical downlink shared channel (PDSCH) power level (Ra) relative to the power of the cell-specific reference signal. This value is expressed in dB. Measurement uses the DOWNLINK_USER_DEFINED_CELL_SPECIFIC_RATIO attribute to calculate the Rb. Refer to section 3.3 of the 3GPP 36.521 specification for more information about Ra.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the physical downlink shared channel (PDSCH) power level (Ra) relative to the power of the cell-specific reference signal. This value is expressed in dB. Measurement uses the DOWNLINK_USER_DEFINED_CELL_SPECIFIC_RATIO attribute to calculate the Rb. Refer to section 3.3 of the 3GPP 36.521 specification for more information about Ra.
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_pdsch_resource_block_allocation(selector_string)[source]

Gets the resource blocks of the physical downlink shared channel (PDSCH) allocation.

The following string formats are supported for this property:

1) RB _StartValue1-RB _StopValue1,*RB* _StartValue2-RB _StopValue2

2) RB ₁,*RB* ₂

3) RB _StartValue1-RB _StopValue1, RB ₁,*RB* _StartValue2-RB _StopValue2,*RB* ₂

For example: If the RB allocation is 0-5,7,8,10-15, the RB allocation string specifies contiguous resource blocks from 0 to 5, resource block 7, resource block 8, and contiguous resource blocks from 10 to 15.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure or read this attribute.

The default value is 0-49.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the resource blocks of the physical downlink shared channel (PDSCH) allocation.
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_phich_duration(selector_string)[source]

Gets the physical hybrid-ARQ indicator channel (PHICH) duration.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is Normal.

Name (Value)	Description
Normal (0)	Orthogonal sequences of length 4 is used to extract PHICH.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DownlinkUserDefinedPhichDuration):: Specifies the physical hybrid-ARQ indicator channel (PHICH) duration.
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_phich_power(selector_string)[source]

Gets the power of all BPSK symbols in a physical hybrid-ARQ indicator channel (PHICH) sequence. This value is expressed in dB.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of all BPSK symbols in a physical hybrid-ARQ indicator channel (PHICH) sequence. This value is expressed in dB.
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_phich_resource(selector_string)[source]

Gets the physical channel hybridARQ indicator channel (PHICH) resource value. This value is expressed in Ng. This attribute is used to calculate number of PHICH resource groups. Refer to section 6.9 of the 3GPP 36.211 specification for more information about PHICH.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 1/6.

Name (Value)	Description
1/6 (0)	Specifies the PHICH resource value is 1/6.
1/2 (1)	Specifies the PHICH resource value is 1/2.
1 (2)	Specifies the PHICH resource value is 1.
2 (3)	Specifies the PHICH resource value is 2.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DownlinkUserDefinedPhichResource):: Specifies the physical channel hybridARQ indicator channel (PHICH) resource value. This value is expressed in Ng. This attribute is used to calculate number of PHICH resource groups. Refer to section 6.9 of the 3GPP 36.211 specification for more information about PHICH.
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_pss_power(selector_string)[source]

Gets the power of primary synchronization signal (PSS) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of primary synchronization signal (PSS) relative to the power of cell-specific reference signal. This value is expressed in dB.
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_pssch_modulation_type(selector_string)[source]

Gets the modulation scheme used in physical sidelink shared channel (PSSCH) of the signal being measured.

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

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PsschModulationType):: Specifies the modulation scheme used in physical sidelink shared channel (PSSCH) of the signal being measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_pssch_number_of_resource_blocks(selector_string)[source]

Gets the number of consecutive resource blocks in a physical sidelink shared channel (PSSCH) allocation.

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

The default value is -1. If you set this attribute to -1, all available resource blocks for the specified bandwidth are configured.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of consecutive resource blocks in a physical sidelink shared channel (PSSCH) allocation.
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_pssch_power(selector_string)[source]

Gets the power of the physical sidelink shared channel (PSSCH) data relative to PSSCH DMRS for a component carrier. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of the physical sidelink shared channel (PSSCH) data relative to PSSCH DMRS for a component carrier. This value is expressed in dB.
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_pssch_resource_block_offset(selector_string)[source]

Gets the starting resource block number of a physical sidelink shared channel (PSSCH) allocation.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 starting resource block number of a physical sidelink shared channel (PSSCH) allocation.
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_pusch_cyclic_shift_field(selector_string)[source]

Gets the cyclic shift field in uplink-related DCI format. When the DMRS_OCC_ENABLED attribute is set to True, the measurement uses the table 5.5.2.1.1-1 of 3GPP 36.211 specification to decide the valued of n(2)DMRS and [w(0) w(1)] for DMRS signal based on Cyclic Shift Field along with TRANSMIT_ANTENNA_TO_ANALYZE.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the cyclic shift field in uplink-related DCI format. When the DMRS_OCC_ENABLED attribute is set to True, the measurement uses the table 5.5.2.1.1-1 of 3GPP 36.211 specification to decide the valued of n(2)DMRS and [w(0) w(1)] for DMRS signal based on Cyclic Shift Field along with TRANSMIT_ANTENNA_TO_ANALYZE.
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_pusch_delta_sequence_shift(selector_string)[source]

Gets the physical uplink shared channel (PUSCH) delta sequence shift, which is used to calculate cyclic shift of the demodulation reference signal (DMRS). Refer to section 5.5.2.1.1 of the 3GPP TS 36.211 specification for more information about the PUSCH delta sequence shift.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 physical uplink shared channel (PUSCH) delta sequence shift, which is used to calculate cyclic shift of the demodulation reference signal (DMRS). Refer to section 5.5.2.1.1 of the 3GPP TS 36.211 specification for more information about the PUSCH delta sequence shift.
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_pusch_modulation_type(selector_string)[source]

Gets the modulation scheme used in the physical uplink shared channel (PUSCH) of the signal being measured.

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

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.
256 QAM (3)	Specifies a 256-QAM modulation scheme.
1024 QAM (4)	Specifies a 1024-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PuschModulationType):: Specifies the modulation scheme used in the physical uplink shared channel (PUSCH) of the signal being measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_pusch_n_dmrs_1(selector_string)[source]

Gets the n_DMRS_1 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a frame.

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

The default value is 0. The valid values for this attribute are defined in table 5.5.2.1.1-2 of the 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the n_DMRS_1 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a frame.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_pusch_n_dmrs_2(selector_string)[source]

Gets the n_DMRS_2 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a slot. The valid values for this attribute are, as defined in table 5.5.2.1.1-1 of the 3GPP TS 36.211 specification.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 n_DMRS_2 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a slot. The valid values for this attribute are, as defined in table 5.5.2.1.1-1 of the 3GPP TS 36.211 specification.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_pusch_number_of_resource_block_clusters(selector_string)[source]

Gets the number of resource allocation clusters, with each cluster including one or more consecutive resource blocks. Refer to 5.5.2.1.1 of the 3GPP TS 36.213 specification for more information about the number of channels in the physical uplink shared channel (PUSCH).

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of resource allocation clusters, with each cluster including one or more consecutive resource blocks. Refer to 5.5.2.1.1 of the 3GPP TS 36.213 specification for more information about the number of channels in the physical uplink shared channel (PUSCH).
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_pusch_number_of_resource_blocks(selector_string)[source]

Gets the number of consecutive resource blocks in a physical uplink shared channel (PUSCH) cluster.

Use “cluster<l>” or “carrier<k>” or “subblock<n>/carrier<k>”/cluster<l>” as the selector string to configure or read this attribute.

The default value is -1. If you set this attribute to -1, all available resource blocks for the specified bandwidth are configured.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of consecutive resource blocks in a physical uplink shared channel (PUSCH) cluster.
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_pusch_power(selector_string)[source]

Gets the power of the physical uplink shared channel (PUSCH) data relative to PUSCH DMRS for a component carrier. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of the physical uplink shared channel (PUSCH) data relative to PUSCH DMRS for a component carrier. This value is expressed in dB.
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_pusch_resource_block_offset(selector_string)[source]

Gets the starting resource block number of a physical uplink shared channel (PUSCH) cluster.

Use “cluster<l>” or “carrier<k>” or “subblock<n>/carrier<k>”/cluster<l>” 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 starting resource block number of a physical uplink shared channel (PUSCH) cluster.
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_spacing_type(selector_string)[source]

Gets the spacing between two adjacent component carriers within a subblock. Refer to the Channel Spacing and Carrier Frequency Offset Definition and Reference Frequency topics for more information about component carrier spacing.

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

The default value is Nominal.

Name (Value)	Description
Nominal (0)	Calculates the frequency spacing between component carriers, as defined in section 5.4.1A in the 3GPP TS 36.521 specification, and sets the CC Freq attribute.
Minimum (1)	Calculates the frequency spacing between component carriers, as defined in section 5.4.1A of the 3GPP TS 36.521 specification, and sets the CC Freq attribute.
User (2)	The CC frequency that you configure in the CC Freq attribute is used.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ComponentCarrierSpacingType):: Specifies the spacing between two adjacent component carriers within a subblock. Refer to the Channel Spacing and Carrier Frequency Offset Definition and Reference Frequency topics for more information about component carrier spacing.
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_srs_b_hop(selector_string)[source]

Gets the SRS hopping bandwidth b_hop. Frequency hopping for SRS signal is enabled when the value of SRS b_hop attribute is less than the value of SRS_B_SRS attribute.

If the given measurement interval is more than one frame, use the multi-frame generation with digital trigger at the start of the first frame for accurate demodulation, since hopping pattern will vary across frames.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the SRS hopping bandwidth b_hop. Frequency hopping for SRS signal is enabled when the value of SRS b_hop attribute is less than the value of SRS_B_SRS attribute.
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_srs_b_srs(selector_string)[source]

Gets the UE specific SRS bandwidth configuration B:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the UE specific SRS bandwidth configuration B:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_c_srs(selector_string)[source]

Gets the cell-specific SRS bandwidth configuration C:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the cell-specific SRS bandwidth configuration C:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_enabled(selector_string)[source]

Gets whether the LTE signal getting measured contains SRS transmission.

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

The default value is False.

Name (Value)	Description
False (0)	Measurement expects signal without SRS transmission.
True (1)	Measurement expects signal with SRS transmission.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SrsEnabled):: Specifies whether the LTE signal getting measured contains SRS transmission.
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_srs_i_srs(selector_string)[source]

Gets the SRS configuration index I:sub:`SRS `. It is used to determine the SRS periodicity and SRS subframe offset. It is a UE specific attribute which defines whether the SRS is transmitted in the subframe reserved for SRS by SRS subframe configuration. Refer to 3GPP 36.213 specification for more details.

If the periodicity of the given SRS configuration is more than one frame, use the multi-frame generation with a digital trigger at the start of the first frame for accurate demodulation.

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

The default value is 0. When you set the DUPLEX_SCHEME attribute to FDD, valid values are from 0 to 636, and when you set the Duplex Scheme attribute to TDD, valid values are from 0 to 644.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the SRS configuration index I:sub:`SRS `. It is used to determine the SRS periodicity and SRS subframe offset. It is a UE specific attribute which defines whether the SRS is transmitted in the subframe reserved for SRS by SRS subframe configuration. Refer to 3GPP 36.213 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_k_tc(selector_string)[source]

Gets the transmission comb index. If you set this attribute to 0, SRS is transmitted on the even subcarriers in the allocated region. If you set this attribute to 1, SRS is transmitted on the odd subcarriers in the allocated region.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 transmission comb index. If you set this attribute to 0, SRS is transmitted on the even subcarriers in the allocated region. If you set this attribute to 1, SRS is transmitted on the odd subcarriers in the allocated region.
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_srs_maximum_up_pts_enabled(selector_string)[source]

Gets SRS MaxUpPTS parameter which determines whether SRS is transmitted in all possible RBs of UpPTS symbols in LTE TDD. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

The default value is False.

Name (Value)	Description
False (0)	In special subframe, SRS is transmitted in RBs specified by SRS bandwidth configurations.
True (1)	In special subframe, SRS is transmitted in all possible RBs.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SrsMaximumUpPtsEnabled):: Specifies SRS MaxUpPTS parameter which determines whether SRS is transmitted in all possible RBs of UpPTS symbols in LTE TDD. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_n_rrc(selector_string)[source]

Gets the SRS frequency domain position n:sub:`RRC `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the SRS frequency domain position n:sub:`RRC `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_n_srs_cs(selector_string)[source]

Gets the cyclic shift value n:sub:`SRS ^CS`used for generating SRS base sequence. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the cyclic shift value n:sub:`SRS ^CS`used for generating SRS base sequence. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_power(selector_string)[source]

Gets the average power of SRS transmission with respect to PUSCH DMRS power. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the average power of SRS transmission with respect to PUSCH DMRS power. This value is expressed in dB.
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_srs_subframe_1_n_ra(selector_string)[source]

Gets the number of format 4 PRACH allocations in UpPTS for Subframe 1, first special subframe, in LTE TDD.

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

The default value is 0. Valid values are 0 to 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of format 4 PRACH allocations in UpPTS for Subframe 1, first special subframe, in LTE TDD.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_srs_subframe_6_n_ra(selector_string)[source]

Gets the number of format 4 PRACH allocations in UpPTS for Subframe 6, second special subframe, in LTE TDD. It is ignored for UL/DL Configuration 3, 4, and 5.

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

The default value is 0. Valid values are 0 to 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of format 4 PRACH allocations in UpPTS for Subframe 6, second special subframe, in LTE TDD. It is ignored for UL/DL Configuration 3, 4, and 5.
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_srs_subframe_configuration(selector_string)[source]

Gets the SRS subframe configuration specified in the Table 5.5.3.3-1 of 3GPP 36.211 specification. It is a cell-specific attribute. This attribute defines the subframes that are reserved for SRS transmission in a given cell.

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

The default value is 0. When you set the DUPLEX_SCHEME attribute to FDD, valid values are from 0 to 14, and when you set the Duplex Scheme attribute to TDD, valid values are from 0 to 13.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the SRS subframe configuration specified in the Table 5.5.3.3-1 of 3GPP 36.211 specification. It is a cell-specific attribute. This attribute defines the subframes that are reserved for SRS transmission in a given cell.
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_sss_power(selector_string)[source]

Gets the power of secondary synchronization signal (SSS) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power of secondary synchronization signal (SSS) relative to the power of cell-specific reference signal. This value is expressed in dB.
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_group_hopping_enabled(selector_string)[source]

Gets whether the sequence group number hopping for demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement uses zero as the sequence group number for all the slots.
True (1)	Calculates the sequence group number for each slot, as defined in the section 5.5.1.3 of 3GPP 36.211 Specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.UplinkGroupHoppingEnabled):: Specifies whether the sequence group number hopping for demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_uplink_sequence_hopping_enabled(selector_string)[source]

Gets whether the base sequence number hopping for the demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification. This attribute is only valid only when you set the PUSCH_NUMBER_OF_RESOURCE_BLOCKS attribute to a value greater than 5.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement uses zero as the base sequence number for all the slots.
True (1)	Calculates the base sequence number for each slot, as defined in the section 5.5.1.4 of 3GPP 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.UplinkSequenceHoppingEnabled):: Specifies whether the base sequence number hopping for the demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification. This attribute is only valid only when you set the PUSCH_NUMBER_OF_RESOURCE_BLOCKS attribute to a value greater than 5.
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)

set_auto_control_channel_power_detection_enabled(selector_string, value)[source]

Sets whether the value of PSS_POWER, SSS_POWER, PBCH_POWER, PDCCH_POWER, and PCFICH_POWER attributes are auto-detected by the measurement or user-specified. Currently, auto-detection of PHICH_POWER attribute is not supported. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

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

The default value is True.

Name (Value)	Description
False (0)	The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, PHICH Power, and PCFICH Power attributes that you specify are used for the measurement.
True (1)	The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, and PCFICH Power attributes are auto-detected and used for the measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoControlChannelPowerDetectionEnabled, int) – Specifies whether the value of PSS_POWER, SSS_POWER, PBCH_POWER, PDCCH_POWER, and PCFICH_POWER attributes are auto-detected by the measurement or user-specified. Currently, auto-detection of PHICH_POWER attribute is not supported. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

Returns:

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

Return type:

int

set_auto_npusch_channel_detection_enabled(selector_string, value)[source]

Sets whether the values of the NPUSCH_TONE_OFFSET, NPUSCH_NUMBER_OF_TONES, and NPUSCH_MODULATION_TYPE attributes are auto-detected by the measurement or specified by you.

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

Name (Value)	Description
False (0)	The measurement uses the values that you specify for the NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH Mod Type attributes.
True (1)	The measurement uses the values of the NPUSCH Tone Offset, NPUSCH Number of Tones, and NPUSCH Mod Type attributes that are auto-detected.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoNPuschChannelDetectionEnabled, int) – Specifies whether the values of the NPUSCH_TONE_OFFSET, NPUSCH_NUMBER_OF_TONES, and NPUSCH_MODULATION_TYPE attributes are auto-detected by the measurement or specified by you.

Returns:

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

Return type:

int

set_auto_pcfich_cfi_detection_enabled(selector_string, value)[source]

Sets whether the value of PCFICH_CFI attribute is auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

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

The default value is True.

Name (Value)	Description
False (0)	The value of PCFICH CFI attribute used for the measurement is specified by you.
True (1)	The value of PCFICH CFI attribute used for the measurement is auto-detected. This value is obtained by decoding the PCFICH channel.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoPcfichCfiDetectionEnabled, int) – Specifies whether the value of PCFICH_CFI attribute is auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

Returns:

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

Return type:

int

set_auto_pdsch_channel_detection_enabled(selector_string, value)[source]

Sets whether the values of the PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding PDSCH_CW0_MODULATION_TYPE attribute, and the PDSCH_POWER attribute are auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the values of the PDSCH RB Allocation attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute that you specify.
True (1)	The measurement uses the values of the PDSCH RB Allocation attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute that are auto-detected.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoPdschChannelDetectionEnabled, int) – Specifies whether the values of the PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding PDSCH_CW0_MODULATION_TYPE attribute, and the PDSCH_POWER attribute are auto-detected by the measurement or user-specified. This attribute is not valid, when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Uplink.

Returns:

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

Return type:

int

set_auto_resource_block_detection_enabled(selector_string, value)[source]

Sets whether the values of the PUSCH_MODULATION_TYPE, PUSCH_NUMBER_OF_RESOURCE_BLOCK_CLUSTERS, PUSCH_RESOURCE_BLOCK_OFFSET, and PUSCH_NUMBER_OF_RESOURCE_BLOCKS attributes are auto-detected by the measurement or if you specify the values of these attributes.

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

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

The default value is True.

Name (Value)	Description
False (0)	The values of the PUSCH Mod Type, PUSCH Num Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes that you specify are used for the measurement.
True (1)	The values of the PUSCH Mod Type, PUSCH Num Clusters, PUSCH RB Offset, and PUSCH Num RBs attributes are detected automatically and used for the measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoResourceBlockDetectionEnabled, int) – Specifies whether the values of the PUSCH_MODULATION_TYPE, PUSCH_NUMBER_OF_RESOURCE_BLOCK_CLUSTERS, PUSCH_RESOURCE_BLOCK_OFFSET, and PUSCH_NUMBER_OF_RESOURCE_BLOCKS attributes are auto-detected by the measurement or if you specify the values of these attributes.

Returns:

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

Return type:

int

set_bandwidth(selector_string, value)[source]

Sets the channel bandwidth of the signal being measured. This value is expressed in Hz.

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

The default value is 10 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the channel bandwidth of the signal being measured. 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_cell_id(selector_string, value)[source]

Sets a physical layer cell identity.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies a physical layer cell identity.

Returns:

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

Return type:

int

set_component_carrier_at_center_frequency(selector_string, value)[source]

Sets the index of the component carrier having its center at the user-configured center frequency. RFmx LTE uses this attribute along with COMPONENT_CARRIER_SPACING_TYPE attribute to calculate the value of the COMPONENT_CARRIER_FREQUENCY.

Refer to the Carrier Frequency Offset Definition and Reference Frequency topic for more information about component carrier frequency.

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

Valid values are -1, 0, 1 … n - 1, inclusive, where n is the number of component carriers in the subblock.

The default value is -1. If the value is -1, the component carrier frequency values are calculated such that the center of aggregated carriers (subblock) lies at the Center Frequency. This attribute is ignored if you set the CC Spacing Type attribute to User.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the index of the component carrier having its center at the user-configured center frequency. RFmx LTE uses this attribute along with COMPONENT_CARRIER_SPACING_TYPE attribute to calculate the value of the COMPONENT_CARRIER_FREQUENCY.

Returns:

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

Return type:

int

set_cyclic_prefix_mode(selector_string, value)[source]

Sets the cyclic prefix (CP) duration and the number of symbols in a slot for the signal being measured.

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

The default value is Normal.

Name (Value)	Description
Normal (0)	The CP duration is 4.67 microseconds, and the number of symbols in a slot is 7.
Extended (1)	The CP duration is 16.67 microseconds, and the number of symbols in a slot is 6.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.CyclicPrefixMode, int) – Specifies the cyclic prefix (CP) duration and the number of symbols in a slot for the signal being measured.

Returns:

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

Return type:

int

set_dmrs_occ_enabled(selector_string, value)[source]

Sets whether orthogonal cover codes (OCCs) need to be used on the demodulation reference signal (DMRS) signal. The measurement internally sets this attribute to TRUE for multi antenna cases.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement ignores the Cyclic Shift Field and uses the PUSCH n_DMRS_2 field for DMRS calculations.
True (1)	The measurement uses the table 5.5.2.1.1-1 of 3GPP 36.211 specification to decide the value of PUSCH n_DMRS_2 and [w(0) w(1)] for DMRS signal based on the values you set for the Cyclic Shift Field and Tx Antenna to Analyze.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DmrsOccEnabled, int) – Specifies whether orthogonal cover codes (OCCs) need to be used on the demodulation reference signal (DMRS) signal. The measurement internally sets this attribute to TRUE for multi antenna cases.

Returns:

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

Return type:

int

set_downlink_auto_cell_id_detection_enabled(selector_string, value)[source]

Sets whether to enable autodetection of the cell ID. If the signal being measured does not contain primary and secondary sync signal (PSS/SSS), autodetection of cell ID is not possible. Detected cell ID can be fetched using MODACC_RESULTS_DOWNLINK_DETECTED_CELL_ID attribute.

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

Name (Value)	Description
False (0)	The measurement uses the cell ID you configure.
True (1)	The measurement auto detects the cell ID.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DownlinkAutoCellIDDetectionEnabled, int) – Specifies whether to enable autodetection of the cell ID. If the signal being measured does not contain primary and secondary sync signal (PSS/SSS), autodetection of cell ID is not possible. Detected cell ID can be fetched using MODACC_RESULTS_DOWNLINK_DETECTED_CELL_ID attribute.

Returns:

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

Return type:

int

set_downlink_channel_configuration_mode(selector_string, value)[source]

Sets the channel configuration mode.

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

Name (Value)	Description
User Defined (1)	You have to manually set all the signals and channels.
Test Model (2)	You need to select a test model using the DL Test Model attribute, which will configure all the signals and channels automatically according to the 3GPP specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DownlinkChannelConfigurationMode, int) – Specifies the channel configuration mode.

Returns:

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

Return type:

int

set_downlink_number_of_subframes(selector_string, value)[source]

Sets the number of unique subframes transmitted by the DUT. If you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model, this attribute will be set to 10 for FDD and 20 for TDD by default.

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

The default value is 10. Valid values are 10 and 20.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of unique subframes transmitted by the DUT. If you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model, this attribute will be set to 10 for FDD and 20 for TDD by default.

Returns:

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

Return type:

int

set_downlink_test_model(selector_string, value)[source]

Sets the E-UTRA test model type when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. Refer to section 6.1.1 of the 3GPP 36.141 specification for more information regarding test model configurations.

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

The default value is TM1.1.

Name (Value)	Description
TM1.1 (0)	Specifies an E-UTRA Test Model 1.1.
TM1.2 (1)	Specifies an E-UTRA Test Model 1.2.
TM2 (2)	Specifies an E-UTRA Test Model 2.
TM2a (3)	Specifies an E-UTRA Test Model 2a.
TM2b (8)	Specifies an E-UTRA Test Model 2b.
TM3.1 (4)	Specifies an E-UTRA Test Model 3.1.
TM3.1a (7)	Specifies an E-UTRA Test Model 3.1a.
TM3.1b (9)	Specifies an E-UTRA Test Model 3.1b.
TM3.2 (5)	Specifies an E-UTRA Test Model 3.2.
TM3.3 (6)	Specifies an E-UTRA Test Model 3.3.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DownlinkTestModel, int) – Specifies the E-UTRA test model type when you set the DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to Test Model. Refer to section 6.1.1 of the 3GPP 36.141 specification for more information regarding test model configurations.

Returns:

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

Return type:

int

set_downlink_user_defined_cell_specific_ratio(selector_string, value)[source]

Sets the ratio Rho_b/Rho_afor the cell-specific ratio of one, two, or four cell-specific antenna ports as described in Table 5.2-1 in section 5.2 of the 3GPP TS 36.213 specification. This attribute determines the power of the channel resource element (RE) in the symbols that do not contain the reference symbols.

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

The default value is P_B=0.

Name (Value)	Description
P_B=0 (0)	Specifies a ratio of 1 for one antenna port and 5/4 for two or four antenna ports.
P_B=1 (1)	Specifies a ratio of 4/5 for one antenna port and 1 for two or four antenna ports.
P_B=2 (2)	Specifies a ratio of 3/5 for one antenna port and 3/4 for two or four antenna ports.
P_B=3 (3)	Specifies a ratio of 2/5 for one antenna port and 1/2 for two or four antenna ports.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DownlinkUserDefinedRatio, int) – Specifies the ratio Rho_b/Rho_afor the cell-specific ratio of one, two, or four cell-specific antenna ports as described in Table 5.2-1 in section 5.2 of the 3GPP TS 36.213 specification. This attribute determines the power of the channel resource element (RE) in the symbols that do not contain the reference symbols.

Returns:

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

Return type:

int

set_emtc_analysis_enabled(selector_string, value)[source]

Sets whether the component carrier contains enhanced machine type communications (Cat-M1 or Cat-M2) transmission.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement considers the signal as LTE FDD/TDD transmission.
True (1)	Detects the eMTC half duplex pattern, narrow band hopping, and eMTC guard symbols present in the uplink transmission.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.EmtcAnalysisEnabled, int) – Specifies whether the component carrier contains enhanced machine type communications (Cat-M1 or Cat-M2) transmission.

Returns:

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

Return type:

int

set_frequency(selector_string, value)[source]

Sets the offset of the component carrier from the subblock center frequency that you configure in the CENTER_FREQUENCY attribute. This value is expressed in Hz. This attribute is valid only when you set the COMPONENT_CARRIER_SPACING_TYPE attribute to User.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the offset of the component carrier from the subblock center frequency that you configure in the CENTER_FREQUENCY attribute. This value is expressed in Hz. This attribute is valid only when you set the COMPONENT_CARRIER_SPACING_TYPE attribute to User.

Returns:

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

Return type:

int

set_laa_downlink_number_of_ending_symbols(selector_string, value)[source]

Sets the number of ending symbols in the last subframe of an LAA downlink burst. Refer to section 4.3 of the 3GPP 36.211 specification for more information regarding LAA downlink number of ending symbols.

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

The default value is 14.

Name (Value)	Description
3 (3)	The number of ending symbols in the last subframe of an LAA downlink burst is 3.
6 (6)	The number of ending symbols in the last subframe of an LAA downlink burst is 6.
9 (9)	The number of ending symbols in the last subframe of an LAA downlink burst is 9.
10 (10)	The number of ending symbols in the last subframe of an LAA downlink burst is 10.
11 (11)	The number of ending symbols in the last subframe of an LAA downlink burst is 11.
12 (12)	The number of ending symbols in the last subframe of an LAA downlink burst is 12.
14 (14)	The number of ending symbols in the last subframe of an LAA downlink burst is 14.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LaaDownlinkNumberOfEndingSymbols, int) – Specifies the number of ending symbols in the last subframe of an LAA downlink burst. Refer to section 4.3 of the 3GPP 36.211 specification for more information regarding LAA downlink number of ending symbols.

Returns:

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

Return type:

int

set_laa_downlink_starting_symbol(selector_string, value)[source]

Sets the starting symbol number in the first subframe of an LAA downlink burst. Refer to section 13A of the 3GPP 36.213 specification for more information regarding LAA downlink starting symbol.

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

The default value is 0.

Name (Value)	Description
0 (0)	The first subframe of an LAA downlink burst starts at symbol 0.
7 (7)	The first subframe of an LAA downlink burst starts at symbol 7.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LaaDownlinkStartingSymbol, int) – Specifies the starting symbol number in the first subframe of an LAA downlink burst. Refer to section 13A of the 3GPP 36.213 specification for more information regarding LAA downlink starting symbol.

Returns:

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

Return type:

int

set_laa_number_of_subframes(selector_string, value)[source]

Sets the number of subframes in an LAA burst including the starting subframe.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of subframes in an LAA burst including the starting subframe.

Returns:

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

Return type:

int

set_laa_starting_subframe(selector_string, value)[source]

Sets the starting subframe of an LAA burst.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 starting subframe of an LAA burst.

Returns:

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

Return type:

int

set_laa_uplink_ending_symbol(selector_string, value)[source]

Sets the ending symbol number in the last subframe of an LAA uplink burst. Refer to section 5.3.3.1.1A of the 3GPP 36.212 specification for more information regarding LAA uplink ending symbol.

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

The default value is 13.

Name (Value)	Description
12 (12)	The last subframe of an LAA uplink burst ends at symbol 12.
13 (13)	The last subframe of an LAA uplink burst ends at symbol 13.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LaaUplinkEndingSymbol, int) – Specifies the ending symbol number in the last subframe of an LAA uplink burst. Refer to section 5.3.3.1.1A of the 3GPP 36.212 specification for more information regarding LAA uplink ending symbol.

Returns:

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

Return type:

int

set_laa_uplink_start_position(selector_string, value)[source]

Sets the starting position of symbol 0 in the first subframe of an LAA uplink burst. Refer to section 5.6 of the 3GPP 36.211 specification for more information regarding LAA uplink start position.

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

The default value is 00.

Name (Value)	Description
00 (0)	The symbol 0 in the first subframe of an LAA uplink burst is completely occupied. There is no idle duration.
01 (1)	The starting position of symbol 0 in the first subframe of an LAA uplink burst is calculated as per section 5.6 (frame structure type 3) of the 3GPP 36.211 specification. The symbol is partially occupied.
10 (2)	The starting position of symbol 0 in the first subframe of an LAA uplink burst is calculated as per section 5.6 (frame structure type 3) of the 3GPP 36.211 specification. The symbol is partially occupied.
11 (3)	The symbol 0 in the first subframe of an LAA uplink burst is completely idle. Symbol 0 is not transmitted in this case.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LaaUplinkStartPosition, int) – Specifies the starting position of symbol 0 in the first subframe of an LAA uplink burst. Refer to section 5.6 of the 3GPP 36.211 specification for more information regarding LAA uplink start position.

Returns:

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

Return type:

int

set_n_cell_id(selector_string, value)[source]

Sets the narrowband physical layer cell identity.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the narrowband physical layer cell identity.

Returns:

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

Return type:

int

set_nb_iot_downlink_channel_configuration_mode(selector_string, value)[source]

Sets the downlink channel configuration mode for NB-IoT.

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

Name (Value)	Description
User Defined (1)	You have to manually set all the signals and channels.
Test Model (2)	Configures all the signals and channels automatically according to the 3GPP NB-IoT test model specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NBIoTDownlinkChannelConfigurationMode, int) – Specifies the downlink channel configuration mode for NB-IoT.

Returns:

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

Return type:

int

set_nb_iot_uplink_subcarrier_spacing(selector_string, value)[source]

Sets the subcarrier bandwidth of an NB-IoT signal. This attribute specifies the spacing between adjacent subcarriers.

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

The default value is 15 kHz.

Name (Value)	Description
15 kHz (0)	The subcarrier spacing is 15 kHz.
3.75 kHz (1)	The subcarrier spacing is 3.75 kHz.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NBIoTUplinkSubcarrierSpacing, int) – Specifies the subcarrier bandwidth of an NB-IoT signal. This attribute specifies the spacing between adjacent subcarriers.

Returns:

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

Return type:

int

set_npdsch_enabled(selector_string, value)[source]

Sets whether NPDSCH is active in a particular subframe. Note that in even-numbered frames, subframes 0, 5, and 9 are reserved for NPBCH, NPSS, and NSSS. In odd-numbered frames, subframes 10 and 15 are reserved for NPBCH and NPSS.The measurement will return an error if you try to configure NPDSCH for those subframes.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is False.

Name (Value)	Description
False (0)	Indicates to the measurement that NPDSCH is not present in a particular subframe.
True (1)	Indicates to the measurement that NPDSCH is present in a particular subframe.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NpdschEnabled, int) – Specifies whether NPDSCH is active in a particular subframe. Note that in even-numbered frames, subframes 0, 5, and 9 are reserved for NPBCH, NPSS, and NSSS. In odd-numbered frames, subframes 10 and 15 are reserved for NPBCH and NPSS.The measurement will return an error if you try to configure NPDSCH for those subframes.

Returns:

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

Return type:

int

set_npdsch_modulation_type(selector_string, value)[source]

Sets the modulation scheme used in NB-IoT physical downlink shared channel (NPDSCH) of the signal being measured.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NpdschModulationType, int) – Specifies the modulation scheme used in NB-IoT physical downlink shared channel (NPDSCH) of the signal being measured.

Returns:

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

Return type:

int

set_npdsch_power(selector_string, value)[source]

Sets the NB-IoT physical downlink shared channel (NPDSCH) power level relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the NB-IoT physical downlink shared channel (NPDSCH) power level relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

Returns:

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

Return type:

int

set_npss_power(selector_string, value)[source]

Sets the power of the NB-IoT primary synchronization signal (NPSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of the NB-IoT primary synchronization signal (NPSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

Returns:

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

Return type:

int

set_npusch_dmrs_base_sequence_index(selector_string, value)[source]

Sets the base sequence index of the Narrowband Physical Uplink Shared Channel (NPUSCH) DMRS as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_DMRS_BASE_SEQUENCE_MODE attribute to Manual, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

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

The default value is 0.

For 3 tones, valid values are 0 to 11, inclusive.
For 6 tones, valid values are 0 to 13, inclusive.
For 12 tones, valid values are 0 to 29, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the base sequence index of the Narrowband Physical Uplink Shared Channel (NPUSCH) DMRS as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_DMRS_BASE_SEQUENCE_MODE attribute to Manual, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

Returns:

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

Return type:

int

set_npusch_dmrs_base_sequence_mode(selector_string, value)[source]

Sets whether the NPUSCH_DMRS_BASE_SEQUENCE_INDEX attribute is computed by the measurement or specified by you. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_FORMAT attribute to 1, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

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

The default value is Auto.

Name (Value)	Description
Manual (0)	The measurement uses the value that you specify for the NPUSCH DMRS Base Sequence Index attribute.
Auto (1)	The measurement uses the value of NCell ID attribute to compute the NPUSCH DMRS Base Sequence Index as defined in section 10.1.4.1.2 of the 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NPuschDmrsBaseSequenceMode, int) – Specifies whether the NPUSCH_DMRS_BASE_SEQUENCE_INDEX attribute is computed by the measurement or specified by you. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to False, the NPUSCH_FORMAT attribute to 1, and the NPUSCH_NUMBER_OF_TONES attribute to 3, 6, or 12.

Returns:

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

Return type:

int

set_npusch_dmrs_cyclic_shift(selector_string, value)[source]

Sets the cyclic shift of the narrowband physical uplink shared channel (NPUSCH) DMRS as defined in Table 10.1.4.1.2-3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_NUMBER_OF_TONES attribute to 3 or 6. If the value of NPUSCH Num Tones attribute is 12, the NPUSCH DMRS Cyclic Shift attribute has a fixed value of 0.

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

The default value is 0.

For 3 tones, valid values are 0 to 2, inclusive.
For 6 tones, valid values are 0 to 3, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the cyclic shift of the narrowband physical uplink shared channel (NPUSCH) DMRS as defined in Table 10.1.4.1.2-3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_NUMBER_OF_TONES attribute to 3 or 6. If the value of NPUSCH Num Tones attribute is 12, the NPUSCH DMRS Cyclic Shift attribute has a fixed value of 0.

Returns:

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

Return type:

int

set_npusch_dmrs_delta_sequence_shift(selector_string, value)[source]

Sets the delta sequence shift of the narrowband physical uplink shared channel (NPUSCH) DMRS, which is used to calculate the sequence shift pattern. This value is used to compute the sequence group number as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to True.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the delta sequence shift of the narrowband physical uplink shared channel (NPUSCH) DMRS, which is used to calculate the sequence shift pattern. This value is used to compute the sequence group number as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification. This attribute is valid when you set the NPUSCH_DMRS_GROUP_HOPPING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_npusch_dmrs_group_hopping_enabled(selector_string, value)[source]

Sets whether the group hopping is enabled for narrowband physical uplink shared channel (NPUSCH) DMRS. This attribute is valid only when the NPUSCH_FORMAT is 1.

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

The default value is False.

Name (Value)	Description
False (0)	Group hopping is disabled.
True (1)	Group hopping is enabled. The sequence group number is calculated as defined in section 10.1.4.1.3 of the 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NPuschDmrsGroupHoppingEnabled, int) – Specifies whether the group hopping is enabled for narrowband physical uplink shared channel (NPUSCH) DMRS. This attribute is valid only when the NPUSCH_FORMAT is 1.

Returns:

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

Return type:

int

set_npusch_format(selector_string, value)[source]

Sets the NPUSCH format. A value of 1 indicates that narrowband physical uplink shared channel (NPUSCH) carries user data (UL-SCH) and a value of 2 indicates that NPUSCH carries uplink control information.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the NPUSCH format. A value of 1 indicates that narrowband physical uplink shared channel (NPUSCH) carries user data (UL-SCH) and a value of 2 indicates that NPUSCH carries uplink control information.

Returns:

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

Return type:

int

set_npusch_modulation_type(selector_string, value)[source]

Sets the modulation type that is used by the narrowband physical uplink shared channel (NPUSCH). This attribute is valid when NPUSCH_NUMBER_OF_TONES is equal to 1 and NPUSCH_FORMAT is equal to 1. The modulation type for other configurations is defined in Table 10.1.3.2-1 of the 3GPP TS 36.211 specification.

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

The default value is BPSK.

Name (Value)	Description
BPSK (0)	Specifies a BPSK modulation scheme.
QPSK (1)	Specifies a QPSK modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.NPuschModulationType, int) – Specifies the modulation type that is used by the narrowband physical uplink shared channel (NPUSCH). This attribute is valid when NPUSCH_NUMBER_OF_TONES is equal to 1 and NPUSCH_FORMAT is equal to 1. The modulation type for other configurations is defined in Table 10.1.3.2-1 of the 3GPP TS 36.211 specification.

Returns:

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

Return type:

int

set_npusch_number_of_tones(selector_string, value)[source]

Sets the number of subcarriers (tones) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).

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

The default value is 1.

For Format 1 and 15 kHz subcarrier spacing, the valid values are 1, 3, 6, and 12.

For Format 1, 3.75 kHz subcarrier spacing, and Format 2, the valid value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of subcarriers (tones) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).

Returns:

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

Return type:

int

set_npusch_starting_slot(selector_string, value)[source]

Sets the starting slot number of the NPUSCH burst.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 starting slot number of the NPUSCH burst.

Returns:

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

Return type:

int

set_npusch_tone_offset(selector_string, value)[source]

Sets the location of the starting subcarrier (tone) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).

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

The default value is 0.

For 15 kHz subcarrier spacing, the valid values are as follows:

for 1 tones, 0 to 11, inclusive
for 3 tones, 0, 3, 6, and 9
for 6 tones, 0 and 6
for 12 tones, 0

For 3.75 kHz subcarrier spacing, the valid values are 0 to 47, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the location of the starting subcarrier (tone) within the 200 kHz bandwidth that is allocated to the narrowband physical uplink shared channel (NPUSCH).

Returns:

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

Return type:

int

set_nsss_power(selector_string, value)[source]

Sets the power of the NB-IoT secondary synchronization signal (NSSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of the NB-IoT secondary synchronization signal (NSSS) relative to the power of the NB-IoT downlink reference signal (NRS). This value is expressed in dB.

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_component_carriers(selector_string, value)[source]

Sets the number of component carriers configured within a subblock.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of component carriers configured within a subblock.

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_pdsch_channels(selector_string, value)[source]

Sets the number of physical downlink shared channel (PDSCH) allocations in a subframe.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of physical downlink shared channel (PDSCH) allocations in a subframe.

Returns:

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

Return type:

int

set_pbch_power(selector_string, value)[source]

Sets the power of physical broadcast channel (PBCH) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of physical broadcast channel (PBCH) relative to the power of cell-specific reference signal. This value is expressed in dB.

Returns:

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

Return type:

int

set_pcfich_cfi(selector_string, value)[source]

Sets the control format indicator (CFI) carried by physical control format indicator channel (PCFICH). CFI is used to compute the number of OFDM symbols which will determine the size of physical downlink control channel (PDCCH) within a subframe.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the control format indicator (CFI) carried by physical control format indicator channel (PCFICH). CFI is used to compute the number of OFDM symbols which will determine the size of physical downlink control channel (PDCCH) within a subframe.

Returns:

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

Return type:

int

set_pcfich_power(selector_string, value)[source]

Sets the power of physical control format indicator channel (PCFICH) relative to the power of cell-specific reference signal. This value is expressed in dB.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of physical control format indicator channel (PCFICH) relative to the power of cell-specific reference signal. This value is expressed in dB.

Returns:

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

Return type:

int

set_pdcch_power(selector_string, value)[source]

Sets the power of physical downlink control channel (PDCCH) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of physical downlink control channel (PDCCH) relative to the power of cell-specific reference signal. This value is expressed in dB.

Returns:

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

Return type:

int

set_pdsch_cw_0_modulation_type(selector_string, value)[source]

Sets the modulation type of codeword0 PDSCH allocation.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure or read this attribute.

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.
256 QAM (3)	Specifies a 256-QAM modulation scheme.
1024 QAM (4)	Specifies a 1024-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.UserDefinedPdschCW0ModulationType, int) – Specifies the modulation type of codeword0 PDSCH allocation.

Returns:

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

Return type:

int

set_pdsch_power(selector_string, value)[source]

Sets the physical downlink shared channel (PDSCH) power level (Ra) relative to the power of the cell-specific reference signal. This value is expressed in dB. Measurement uses the DOWNLINK_USER_DEFINED_CELL_SPECIFIC_RATIO attribute to calculate the Rb. Refer to section 3.3 of the 3GPP 36.521 specification for more information about Ra.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the physical downlink shared channel (PDSCH) power level (Ra) relative to the power of the cell-specific reference signal. This value is expressed in dB. Measurement uses the DOWNLINK_USER_DEFINED_CELL_SPECIFIC_RATIO attribute to calculate the Rb. Refer to section 3.3 of the 3GPP 36.521 specification for more information about Ra.

Returns:

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

Return type:

int

set_pdsch_resource_block_allocation(selector_string, value)[source]

Sets the resource blocks of the physical downlink shared channel (PDSCH) allocation.

The following string formats are supported for this property:

1) RB _StartValue1-RB _StopValue1,*RB* _StartValue2-RB _StopValue2

2) RB ₁,*RB* ₂

3) RB _StartValue1-RB _StopValue1, RB ₁,*RB* _StartValue2-RB _StopValue2,*RB* ₂

For example: If the RB allocation is 0-5,7,8,10-15, the RB allocation string specifies contiguous resource blocks from 0 to 5, resource block 7, resource block 8, and contiguous resource blocks from 10 to 15.

Use “PDSCH<m>” or “subframe<l>” or “carrier<k>” or “subblock<n>/carrier<k>/subframe<l>/PDSCH<m>” as the selector string to configure or read this attribute.

The default value is 0-49.

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the resource blocks of the physical downlink shared channel (PDSCH) allocation.

Returns:

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

Return type:

int

set_phich_duration(selector_string, value)[source]

Sets the physical hybrid-ARQ indicator channel (PHICH) duration.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is Normal.

Name (Value)	Description
Normal (0)	Orthogonal sequences of length 4 is used to extract PHICH.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DownlinkUserDefinedPhichDuration, int) – Specifies the physical hybrid-ARQ indicator channel (PHICH) duration.

Returns:

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

Return type:

int

set_phich_power(selector_string, value)[source]

Sets the power of all BPSK symbols in a physical hybrid-ARQ indicator channel (PHICH) sequence. This value is expressed in dB.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of all BPSK symbols in a physical hybrid-ARQ indicator channel (PHICH) sequence. This value is expressed in dB.

Returns:

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

Return type:

int

set_phich_resource(selector_string, value)[source]

Sets the physical channel hybridARQ indicator channel (PHICH) resource value. This value is expressed in Ng. This attribute is used to calculate number of PHICH resource groups. Refer to section 6.9 of the 3GPP 36.211 specification for more information about PHICH.

Use “subframe<l>” or “carrier<k>” or “subblock<n>” or “subblock<n>/carrier<k>/subframe<l>” as the selector string to configure or read this attribute.

The default value is 1/6.

Name (Value)	Description
1/6 (0)	Specifies the PHICH resource value is 1/6.
1/2 (1)	Specifies the PHICH resource value is 1/2.
1 (2)	Specifies the PHICH resource value is 1.
2 (3)	Specifies the PHICH resource value is 2.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DownlinkUserDefinedPhichResource, int) – Specifies the physical channel hybridARQ indicator channel (PHICH) resource value. This value is expressed in Ng. This attribute is used to calculate number of PHICH resource groups. Refer to section 6.9 of the 3GPP 36.211 specification for more information about PHICH.

Returns:

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

Return type:

int

set_pss_power(selector_string, value)[source]

Sets the power of primary synchronization signal (PSS) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of primary synchronization signal (PSS) relative to the power of cell-specific reference signal. This value is expressed in dB.

Returns:

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

Return type:

int

set_pssch_modulation_type(selector_string, value)[source]

Sets the modulation scheme used in physical sidelink shared channel (PSSCH) of the signal being measured.

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

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PsschModulationType, int) – Specifies the modulation scheme used in physical sidelink shared channel (PSSCH) of the signal being measured.

Returns:

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

Return type:

int

set_pssch_number_of_resource_blocks(selector_string, value)[source]

Sets the number of consecutive resource blocks in a physical sidelink shared channel (PSSCH) allocation.

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

The default value is -1. If you set this attribute to -1, all available resource blocks for the specified bandwidth are configured.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of consecutive resource blocks in a physical sidelink shared channel (PSSCH) allocation.

Returns:

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

Return type:

int

set_pssch_power(selector_string, value)[source]

Sets the power of the physical sidelink shared channel (PSSCH) data relative to PSSCH DMRS for a component carrier. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of the physical sidelink shared channel (PSSCH) data relative to PSSCH DMRS for a component carrier. This value is expressed in dB.

Returns:

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

Return type:

int

set_pssch_resource_block_offset(selector_string, value)[source]

Sets the starting resource block number of a physical sidelink shared channel (PSSCH) allocation.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 starting resource block number of a physical sidelink shared channel (PSSCH) allocation.

Returns:

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

Return type:

int

set_pusch_cyclic_shift_field(selector_string, value)[source]

Sets the cyclic shift field in uplink-related DCI format. When the DMRS_OCC_ENABLED attribute is set to True, the measurement uses the table 5.5.2.1.1-1 of 3GPP 36.211 specification to decide the valued of n(2)DMRS and [w(0) w(1)] for DMRS signal based on Cyclic Shift Field along with TRANSMIT_ANTENNA_TO_ANALYZE.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the cyclic shift field in uplink-related DCI format. When the DMRS_OCC_ENABLED attribute is set to True, the measurement uses the table 5.5.2.1.1-1 of 3GPP 36.211 specification to decide the valued of n(2)DMRS and [w(0) w(1)] for DMRS signal based on Cyclic Shift Field along with TRANSMIT_ANTENNA_TO_ANALYZE.

Returns:

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

Return type:

int

set_pusch_delta_sequence_shift(selector_string, value)[source]

Sets the physical uplink shared channel (PUSCH) delta sequence shift, which is used to calculate cyclic shift of the demodulation reference signal (DMRS). Refer to section 5.5.2.1.1 of the 3GPP TS 36.211 specification for more information about the PUSCH delta sequence shift.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 physical uplink shared channel (PUSCH) delta sequence shift, which is used to calculate cyclic shift of the demodulation reference signal (DMRS). Refer to section 5.5.2.1.1 of the 3GPP TS 36.211 specification for more information about the PUSCH delta sequence shift.

Returns:

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

Return type:

int

set_pusch_modulation_type(selector_string, value)[source]

Sets the modulation scheme used in the physical uplink shared channel (PUSCH) of the signal being measured.

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

The default value is QPSK.

Name (Value)	Description
QPSK (0)	Specifies a QPSK modulation scheme.
16 QAM (1)	Specifies a 16-QAM modulation scheme.
64 QAM (2)	Specifies a 64-QAM modulation scheme.
256 QAM (3)	Specifies a 256-QAM modulation scheme.
1024 QAM (4)	Specifies a 1024-QAM modulation scheme.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PuschModulationType, int) – Specifies the modulation scheme used in the physical uplink shared channel (PUSCH) of the signal being measured.

Returns:

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

Return type:

int

set_pusch_n_dmrs_1(selector_string, value)[source]

Sets the n_DMRS_1 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a frame.

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

The default value is 0. The valid values for this attribute are defined in table 5.5.2.1.1-2 of the 3GPP TS 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the n_DMRS_1 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a frame.

Returns:

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

Return type:

int

set_pusch_n_dmrs_2(selector_string, value)[source]

Sets the n_DMRS_2 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a slot. The valid values for this attribute are, as defined in table 5.5.2.1.1-1 of the 3GPP TS 36.211 specification.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 n_DMRS_2 value, which is used to calculate the cyclic shift of the demodulation reference signal (DMRS) in a slot. The valid values for this attribute are, as defined in table 5.5.2.1.1-1 of the 3GPP TS 36.211 specification.

Returns:

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

Return type:

int

set_pusch_number_of_resource_block_clusters(selector_string, value)[source]

Sets the number of resource allocation clusters, with each cluster including one or more consecutive resource blocks. Refer to 5.5.2.1.1 of the 3GPP TS 36.213 specification for more information about the number of channels in the physical uplink shared channel (PUSCH).

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of resource allocation clusters, with each cluster including one or more consecutive resource blocks. Refer to 5.5.2.1.1 of the 3GPP TS 36.213 specification for more information about the number of channels in the physical uplink shared channel (PUSCH).

Returns:

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

Return type:

int

set_pusch_number_of_resource_blocks(selector_string, value)[source]

Sets the number of consecutive resource blocks in a physical uplink shared channel (PUSCH) cluster.

Use “cluster<l>” or “carrier<k>” or “subblock<n>/carrier<k>”/cluster<l>” as the selector string to configure or read this attribute.

The default value is -1. If you set this attribute to -1, all available resource blocks for the specified bandwidth are configured.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of consecutive resource blocks in a physical uplink shared channel (PUSCH) cluster.

Returns:

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

Return type:

int

set_pusch_power(selector_string, value)[source]

Sets the power of the physical uplink shared channel (PUSCH) data relative to PUSCH DMRS for a component carrier. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of the physical uplink shared channel (PUSCH) data relative to PUSCH DMRS for a component carrier. This value is expressed in dB.

Returns:

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

Return type:

int

set_pusch_resource_block_offset(selector_string, value)[source]

Sets the starting resource block number of a physical uplink shared channel (PUSCH) cluster.

Use “cluster<l>” or “carrier<k>” or “subblock<n>/carrier<k>”/cluster<l>” 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 starting resource block number of a physical uplink shared channel (PUSCH) cluster.

Returns:

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

Return type:

int

set_spacing_type(selector_string, value)[source]

Sets the spacing between two adjacent component carriers within a subblock. Refer to the Channel Spacing and Carrier Frequency Offset Definition and Reference Frequency topics for more information about component carrier spacing.

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

The default value is Nominal.

Name (Value)	Description
Nominal (0)	Calculates the frequency spacing between component carriers, as defined in section 5.4.1A in the 3GPP TS 36.521 specification, and sets the CC Freq attribute.
Minimum (1)	Calculates the frequency spacing between component carriers, as defined in section 5.4.1A of the 3GPP TS 36.521 specification, and sets the CC Freq attribute.
User (2)	The CC frequency that you configure in the CC Freq attribute is used.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ComponentCarrierSpacingType, int) –
Specifies the spacing between two adjacent component carriers within a subblock. Refer to the Channel Spacing and Carrier Frequency Offset Definition and Reference Frequency topics for more information about component carrier spacing.

Returns:

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

Return type:

int

set_srs_b_hop(selector_string, value)[source]

Sets the SRS hopping bandwidth b_hop. Frequency hopping for SRS signal is enabled when the value of SRS b_hop attribute is less than the value of SRS_B_SRS attribute.

If the given measurement interval is more than one frame, use the multi-frame generation with digital trigger at the start of the first frame for accurate demodulation, since hopping pattern will vary across frames.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the SRS hopping bandwidth b_hop. Frequency hopping for SRS signal is enabled when the value of SRS b_hop attribute is less than the value of SRS_B_SRS attribute.

Returns:

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

Return type:

int

set_srs_b_srs(selector_string, value)[source]

Sets the UE specific SRS bandwidth configuration B:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the UE specific SRS bandwidth configuration B:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

Returns:

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

Return type:

int

set_srs_c_srs(selector_string, value)[source]

Sets the cell-specific SRS bandwidth configuration C:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the cell-specific SRS bandwidth configuration C:sub:`SRS `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

Returns:

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

Return type:

int

set_srs_enabled(selector_string, value)[source]

Sets whether the LTE signal getting measured contains SRS transmission.

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

The default value is False.

Name (Value)	Description
False (0)	Measurement expects signal without SRS transmission.
True (1)	Measurement expects signal with SRS transmission.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SrsEnabled, int) – Specifies whether the LTE signal getting measured contains SRS transmission.

Returns:

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

Return type:

int

set_srs_i_srs(selector_string, value)[source]

Sets the SRS configuration index I:sub:`SRS `. It is used to determine the SRS periodicity and SRS subframe offset. It is a UE specific attribute which defines whether the SRS is transmitted in the subframe reserved for SRS by SRS subframe configuration. Refer to 3GPP 36.213 specification for more details.

If the periodicity of the given SRS configuration is more than one frame, use the multi-frame generation with a digital trigger at the start of the first frame for accurate demodulation.

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

The default value is 0. When you set the DUPLEX_SCHEME attribute to FDD, valid values are from 0 to 636, and when you set the Duplex Scheme attribute to TDD, valid values are from 0 to 644.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the SRS configuration index I:sub:`SRS `. It is used to determine the SRS periodicity and SRS subframe offset. It is a UE specific attribute which defines whether the SRS is transmitted in the subframe reserved for SRS by SRS subframe configuration. Refer to 3GPP 36.213 specification for more details.

Returns:

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

Return type:

int

set_srs_k_tc(selector_string, value)[source]

Sets the transmission comb index. If you set this attribute to 0, SRS is transmitted on the even subcarriers in the allocated region. If you set this attribute to 1, SRS is transmitted on the odd subcarriers in the allocated region.

Use “carrier<k>” or “subblock<n>/carrier<k>” 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 transmission comb index. If you set this attribute to 0, SRS is transmitted on the even subcarriers in the allocated region. If you set this attribute to 1, SRS is transmitted on the odd subcarriers in the allocated region.

Returns:

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

Return type:

int

set_srs_maximum_up_pts_enabled(selector_string, value)[source]

Sets SRS MaxUpPTS parameter which determines whether SRS is transmitted in all possible RBs of UpPTS symbols in LTE TDD. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

The default value is False.

Name (Value)	Description
False (0)	In special subframe, SRS is transmitted in RBs specified by SRS bandwidth configurations.
True (1)	In special subframe, SRS is transmitted in all possible RBs.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SrsMaximumUpPtsEnabled, int) – Specifies SRS MaxUpPTS parameter which determines whether SRS is transmitted in all possible RBs of UpPTS symbols in LTE TDD. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

Returns:

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

Return type:

int

set_srs_n_rrc(selector_string, value)[source]

Sets the SRS frequency domain position n:sub:`RRC `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the SRS frequency domain position n:sub:`RRC `. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

Returns:

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

Return type:

int

set_srs_n_srs_cs(selector_string, value)[source]

Sets the cyclic shift value n:sub:`SRS ^CS`used for generating SRS base sequence. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the cyclic shift value n:sub:`SRS ^CS`used for generating SRS base sequence. Refer to section 5.5.3.2 of 3GPP 36.211 specification for more details.

Returns:

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

Return type:

int

set_srs_power(selector_string, value)[source]

Sets the average power of SRS transmission with respect to PUSCH DMRS power. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the average power of SRS transmission with respect to PUSCH DMRS power. This value is expressed in dB.

Returns:

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

Return type:

int

set_srs_subframe_1_n_ra(selector_string, value)[source]

Sets the number of format 4 PRACH allocations in UpPTS for Subframe 1, first special subframe, in LTE TDD.

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

The default value is 0. Valid values are 0 to 6.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of format 4 PRACH allocations in UpPTS for Subframe 1, first special subframe, in LTE TDD.

Returns:

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

Return type:

int

set_srs_subframe_6_n_ra(selector_string, value)[source]

Sets the number of format 4 PRACH allocations in UpPTS for Subframe 6, second special subframe, in LTE TDD. It is ignored for UL/DL Configuration 3, 4, and 5.

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

The default value is 0. Valid values are 0 to 6.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of format 4 PRACH allocations in UpPTS for Subframe 6, second special subframe, in LTE TDD. It is ignored for UL/DL Configuration 3, 4, and 5.

Returns:

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

Return type:

int

set_srs_subframe_configuration(selector_string, value)[source]

Sets the SRS subframe configuration specified in the Table 5.5.3.3-1 of 3GPP 36.211 specification. It is a cell-specific attribute. This attribute defines the subframes that are reserved for SRS transmission in a given cell.

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

The default value is 0. When you set the DUPLEX_SCHEME attribute to FDD, valid values are from 0 to 14, and when you set the Duplex Scheme attribute to TDD, valid values are from 0 to 13.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the SRS subframe configuration specified in the Table 5.5.3.3-1 of 3GPP 36.211 specification. It is a cell-specific attribute. This attribute defines the subframes that are reserved for SRS transmission in a given cell.

Returns:

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

Return type:

int

set_sss_power(selector_string, value)[source]

Sets the power of secondary synchronization signal (SSS) relative to the power of cell-specific reference signal. This value is expressed in dB.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power of secondary synchronization signal (SSS) relative to the power of cell-specific reference signal. This value is expressed in dB.

Returns:

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

Return type:

int

set_uplink_group_hopping_enabled(selector_string, value)[source]

Sets whether the sequence group number hopping for demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement uses zero as the sequence group number for all the slots.
True (1)	Calculates the sequence group number for each slot, as defined in the section 5.5.1.3 of 3GPP 36.211 Specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.UplinkGroupHoppingEnabled, int) – Specifies whether the sequence group number hopping for demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification.

Returns:

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

Return type:

int

set_uplink_sequence_hopping_enabled(selector_string, value)[source]

Sets whether the base sequence number hopping for the demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification. This attribute is only valid only when you set the PUSCH_NUMBER_OF_RESOURCE_BLOCKS attribute to a value greater than 5.

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

The default value is False.

Name (Value)	Description
False (0)	The measurement uses zero as the base sequence number for all the slots.
True (1)	Calculates the base sequence number for each slot, as defined in the section 5.5.1.4 of 3GPP 36.211 specification.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.UplinkSequenceHoppingEnabled, int) – Specifies whether the base sequence number hopping for the demodulation reference signal (DMRS) is enabled, as defined in section 5.5.1.3 of the 3GPP TS 36.211 specification. This attribute is only valid only when you set the PUSCH_NUMBER_OF_RESOURCE_BLOCKS attribute to a value greater than 5.

Returns:

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

Return type:

int