CdaConfiguration

Provides methods to configure the Cda measurement.

class nirfmxwcdma.cda_configuration.CdaConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Cda measurement.

configure_measurement_channel(selector_string, spreading_factor, spreading_code, modulation_type, branch)[source]

Configures the spreading factor, spreading code, modulation type, and branch of the channel to be measured.

Parameters:

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

  • spreading_factor (int) –

    This parameter specifies the spreading factor of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

    The default value is 256. Valid values are 2, 4, 8, 16, 32, 64, 128, and 256.

  • spreading_code (int) –

    This parameter specifies the spreading code of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

    The default value is 0. Valid values are 0 to (Spreading Factor - 1).

  • modulation_type (enums.CdaMeasurementChannelModulationType, int) –

    This parameter specifies the modulation type of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

    The default value is BPSK/QPSK.

    Name (Value)

    Description

    BPSK/QPSK (0)

    The modulation type is BPSK.

    4PAM/16QAM (1)

    The modulation type is 4-PAM.

  • branch (enums.CdaMeasurementChannelBranch, int) –

    This parameter specifies the branch of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

    The default value is I.

    Name (Value)

    Description

    I (0)

    The signal is modulated on the in-phase branch.

    Q (1)

    The signal is modulated on the quadrature-phase branch.

Returns:

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

Return type:

int

configure_power_unit(selector_string, power_unit)[source]

Configures the power unit for all code domain power results, except Total Power (dBm).

Parameters:

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

  • power_unit (enums.CdaPowerUnit, int) –

    This parameter specifies the measurement unit of all power results, except, CDA_RESULTS_TOTAL_POWER.

    The default value is dB.

    Name (Value)

    Description

    dB (0)

    Specifies the power relative to the total power.

    dBm (1)

    Specifies the absolute power measured.

Returns:

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

Return type:

int

configure_synchronization_mode_and_interval(selector_string, synchronization_mode, measurement_offset, measurement_length)[source]

Configures the synchronization mode, measurement offset, and measurement length.

Parameters:

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

  • synchronization_mode (enums.CdaSynchronizationMode, int) –

    This parameter specifies whether the measurement is performed from the frame, slot, or symbol boundary.

    The default value is Slot.

    Name (Value)

    Description

    Frame (0)

    The frame boundary is detected, and the measurement is performed over the number of slots expressed by the Measurement Length parameter, starting at Measurement Offset slots from the frame boundary.

    Slot (1)

    The slot boundary is detected and the measurement is performed over the number of slots expressed by Measurement Length parameter, starting at Measurement Offset slots from the slot boundary.

    Arbitrary (2)

    The symbol boundary is detected and the measurement is performed over the number of slots expressed by the Measurement Length parameter, starting at Measurement Offset slots from the symbol boundary.

  • measurement_offset (int) –

    This parameter specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the Synchronization Mode parameter.

    The default value is 0. The Valid values are [0, (15 - Measurement Length)]. The sum of the CDA measurement offset and CDA measurement length must be less than or equal to 15.

  • measurement_length (int) –

    This parameter specifies the duration of the code domain measurement. This value is expressed in slots.

    The default value is 1. Valid values are [1, (15 - Measurement Offset)]. The sum of the CDA measurement offset and CDA measurement length must be less than or equal to 15.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces after performing the CDA measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces after performing the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_iq_offset_removal_enabled(selector_string)[source]

Gets whether to remove the I/Q offset before the CDA measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q offset is not removed before the CDA measurement.

True (1)

the I/Q offset is removed before the CDA measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaIQOffsetRemovalEnabled):

Specifies whether to remove the I/Q offset before the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_channel_branch(selector_string)[source]

Gets the branch of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is Q.

Name (Value)

Description

I (0)

The signal is modulated on the in-phase branch.

Q (1)

The signal is modulated on the quadrature-phase branch.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaMeasurementChannelBranch):

Specifies the branch of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_channel_modulation_type(selector_string)[source]

Gets the modulation type of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is BPSK/QPSK.

Name (Value)

Description

BPSK/QPSK (0)

The modulation type is BPSK.

4PAM/16QAM (1)

The modulation type is 4-PAM.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaMeasurementChannelModulationType):

Specifies the modulation type of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_channel_spreading_code(selector_string)[source]

Gets the spreading code of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is 0. Valid values are 0 to (CDA_MEASUREMENT_CHANNEL_SPREADING_FACTOR - 1).

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the spreading code of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_channel_spreading_factor(selector_string)[source]

Gets the spreading factor of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is 256. Valid values are 2, 4, 8, 16, 32, 64, 128, and 256.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the spreading factor of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the CDA measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the CDA measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_length(selector_string)[source]

Gets the duration of the code domain measurement. This value is expressed in slots.

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

The default value is 1. Valid values are [1, (15 - CDA_MEASUREMENT_OFFSET)]. The sum of the CDA measurement offset and CDA measurement length must be less than or equal to 15.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the duration of the code domain measurement. This value is expressed in slots.

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_measurement_offset(selector_string)[source]

Gets the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE 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 0. Valid values are [0, (15 - CDA_MEASUREMENT_LENGTH)]. The sum of the CDA measurement offset and CDA measurement length must be less than or equal to 15.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE 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_power_unit(selector_string)[source]

Gets the measurement unit of all power results, except CDA_RESULTS_TOTAL_POWER.

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

Name (Value)

Description

dB (0)

Specifies the power relative to the total power.

dBm (1)

Specifies the absolute power measured.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaPowerUnit):

Specifies the measurement unit of all power results, except CDA_RESULTS_TOTAL_POWER.

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_rrc_filter_enabled(selector_string)[source]

Gets whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

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)

Disables the RRC filter in the measurement.

True (1)

Enables the RRC filter in the measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaRrcFilterEnabled):

Specifies whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

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_spectrum_inverted(selector_string)[source]

Gets whether the spectrum of the signal is inverted.

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

The default value is False.

Name (Value)

Description

False (0)

The spectrum is not inverted.

True (1)

The spectrum is inverted.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaSpectrumInverted):

Specifies whether the spectrum of the signal is inverted.

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_synchronization_mode(selector_string)[source]

Gets whether the measurement is performed from the frame, slot, or symbol boundary.

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

Name (Value)

Description

Frame (0)

The frame boundary is detected and the measurement is performed over the number of slots expressed by the CDA Meas Length attribute, starting at CDA Meas Offset slots from the frame boundary.

Slot (1)

The slot boundary is detected and the measurement is performed over the number of slots expressed by CDA Meas Length attribute, starting at CDA Meas Offset slots from the slot boundary.

Arbitrary (2)

The symbol boundary is detected and the measurement is performed over the number of slots expressed by the CDA Meas Length attribute, starting at CDA Meas Offset slots from the symbol boundary.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaSynchronizationMode):

Specifies whether the measurement is performed from the frame, slot, or symbol boundary.

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

Sets whether to enable the traces after performing the CDA measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces after performing the CDA measurement.

Returns:

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

Return type:

int

set_iq_offset_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q offset before the CDA measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q offset is not removed before the CDA measurement.

True (1)

the I/Q offset is removed before the CDA measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaIQOffsetRemovalEnabled, int) – Specifies whether to remove the I/Q offset before the CDA measurement.

Returns:

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

Return type:

int

set_measurement_channel_branch(selector_string, value)[source]

Sets the branch of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is Q.

Name (Value)

Description

I (0)

The signal is modulated on the in-phase branch.

Q (1)

The signal is modulated on the quadrature-phase branch.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaMeasurementChannelBranch, int) – Specifies the branch of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

Returns:

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

Return type:

int

set_measurement_channel_modulation_type(selector_string, value)[source]

Sets the modulation type of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is BPSK/QPSK.

Name (Value)

Description

BPSK/QPSK (0)

The modulation type is BPSK.

4PAM/16QAM (1)

The modulation type is 4-PAM.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaMeasurementChannelModulationType, int) – Specifies the modulation type of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

Returns:

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

Return type:

int

set_measurement_channel_spreading_code(selector_string, value)[source]

Sets the spreading code of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is 0. Valid values are 0 to (CDA_MEASUREMENT_CHANNEL_SPREADING_FACTOR - 1).

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the spreading code of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

Returns:

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

Return type:

int

set_measurement_channel_spreading_factor(selector_string, value)[source]

Sets the spreading factor of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

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

The default value is 256. Valid values are 2, 4, 8, 16, 32, 64, 128, and 256.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the spreading factor of the measurement channel. This value is used to compute the symbol results of the CDA measurement.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the CDA measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the CDA measurement.

Returns:

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

Return type:

int

set_measurement_length(selector_string, value)[source]

Sets the duration of the code domain measurement. This value is expressed in slots.

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

The default value is 1. Valid values are [1, (15 - CDA_MEASUREMENT_OFFSET)]. The sum of the CDA measurement offset and CDA measurement length must be less than or equal to 15.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the duration of the code domain measurement. This value is expressed in slots.

Returns:

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

Return type:

int

set_measurement_offset(selector_string, value)[source]

Sets the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE 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 0. Valid values are [0, (15 - CDA_MEASUREMENT_LENGTH)]. The sum of the CDA measurement offset and CDA measurement length must be less than or equal to 15.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE attribute.

Returns:

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

Return type:

int

set_power_unit(selector_string, value)[source]

Sets the measurement unit of all power results, except CDA_RESULTS_TOTAL_POWER.

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

Name (Value)

Description

dB (0)

Specifies the power relative to the total power.

dBm (1)

Specifies the absolute power measured.
Parameters:
Returns:

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

Return type:

int

set_rrc_filter_enabled(selector_string, value)[source]

Sets whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

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)

Disables the RRC filter in the measurement.

True (1)

Enables the RRC filter in the measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaRrcFilterEnabled, int) – Specifies whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

Returns:

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

Return type:

int

set_spectrum_inverted(selector_string, value)[source]

Sets whether the spectrum of the signal is inverted.

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

The default value is False.

Name (Value)

Description

False (0)

The spectrum is not inverted.

True (1)

The spectrum is inverted.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaSpectrumInverted, int) – Specifies whether the spectrum of the signal is inverted.

Returns:

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

Return type:

int

set_synchronization_mode(selector_string, value)[source]

Sets whether the measurement is performed from the frame, slot, or symbol boundary.

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

Name (Value)

Description

Frame (0)

The frame boundary is detected and the measurement is performed over the number of slots expressed by the CDA Meas Length attribute, starting at CDA Meas Offset slots from the frame boundary.

Slot (1)

The slot boundary is detected and the measurement is performed over the number of slots expressed by CDA Meas Length attribute, starting at CDA Meas Offset slots from the slot boundary.

Arbitrary (2)

The symbol boundary is detected and the measurement is performed over the number of slots expressed by the CDA Meas Length attribute, starting at CDA Meas Offset slots from the symbol boundary.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaSynchronizationMode, int) – Specifies whether the measurement is performed from the frame, slot, or symbol boundary.

Returns:

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

Return type:

int