"""Provides methods to configure the Pvt measurement."""
import functools
import nirfmxgsm.attributes as attributes
import nirfmxgsm.enums as enums
import nirfmxgsm.errors as errors
import nirfmxgsm.internal._helper as _helper
def _raise_if_disposed(f):
"""From https://stackoverflow.com/questions/5929107/decorators-with-parameters."""
@functools.wraps(f)
def aux(*xs, **kws):
meas_obj = xs[0] # parameter 0 is 'self' which is the measurement object
if meas_obj._signal_obj.is_disposed:
raise Exception("Cannot access a disposed Gsm signal configuration")
return f(*xs, **kws)
return aux
[docs]
class PvtConfiguration(object):
"""Provides methods to configure the Pvt measurement."""
def __init__(self, signal_obj):
"""Provides methods to configure the Pvt measurement."""
self._signal_obj = signal_obj
self._session_function_lock = signal_obj._session_function_lock
self._interpreter = signal_obj._interpreter
[docs]
@_raise_if_disposed
def get_measurement_enabled(self, selector_string):
r"""Gets whether to enable the power versus time (PVT) measurement.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (bool):
Specifies whether to enable the power versus time (PVT) measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_MEASUREMENT_ENABLED.value
)
attr_val = bool(attr_val)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_measurement_enabled(self, selector_string, value):
r"""Sets whether to enable the power versus time (PVT) measurement.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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.
Args:
selector_string (string):
Pass an empty string.
value (bool):
Specifies whether to enable the power versus time (PVT) measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_MEASUREMENT_ENABLED.value,
int(value),
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_averaging_enabled(self, selector_string):
r"""Gets whether to enable averaging for the power versus time (PVT) measurement.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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 measurement is performed on a single acquisition. |
+--------------+---------------------------------------------------------+
| True (1) | The measurement is averaged over multiple acquisitions. |
+--------------+---------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.PvtAveragingEnabled):
Specifies whether to enable averaging for the power versus time (PVT) measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_AVERAGING_ENABLED.value
)
attr_val = enums.PvtAveragingEnabled(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_averaging_enabled(self, selector_string, value):
r"""Sets whether to enable averaging for the power versus time (PVT) measurement.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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 measurement is performed on a single acquisition. |
+--------------+---------------------------------------------------------+
| True (1) | The measurement is averaged over multiple acquisitions. |
+--------------+---------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.PvtAveragingEnabled, int):
Specifies whether to enable averaging for the power versus time (PVT) measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.PvtAveragingEnabled else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_AVERAGING_ENABLED.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_averaging_type(self, selector_string):
r"""Gets the averaging type for multiple acquisitions.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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 **RMS**.
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+====================================================================================================================+
| RMS (0) | The power at each sample interval is linearly averaged from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Log (1) | The power at each sample interval is averaged on a logarithmic scale from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Max (3) | The peak power at each sample interval is retained from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Min (4) | The lowest power at each sample interval is retained from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.PvtAveragingType):
Specifies the averaging type for multiple acquisitions.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_AVERAGING_TYPE.value
)
attr_val = enums.PvtAveragingType(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_averaging_type(self, selector_string, value):
r"""Sets the averaging type for multiple acquisitions.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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 **RMS**.
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Name (Value) | Description |
+==============+====================================================================================================================+
| RMS (0) | The power at each sample interval is linearly averaged from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Log (1) | The power at each sample interval is averaged on a logarithmic scale from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Max (3) | The peak power at each sample interval is retained from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
| Min (4) | The lowest power at each sample interval is retained from one acquisition to the next acquisition. |
+--------------+--------------------------------------------------------------------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.PvtAveragingType, int):
Specifies the averaging type for multiple acquisitions.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.PvtAveragingType else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_AVERAGING_TYPE.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_averaging_count(self, selector_string):
r"""Gets the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute to **True**.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute for
the default signal instance. Refer to the Selector String topic for information about the string syntax for named
signals.
The default value is 10.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_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.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_AVERAGING_COUNT.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_averaging_count(self, selector_string, value):
r"""Sets the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute to **True**.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ to configure or read this attribute for
the default signal instance. Refer to the Selector String topic for information about the string syntax for named
signals.
The default value is 10.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the number of acquisitions used for averaging when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute to **True**.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_AVERAGING_COUNT.value, value
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_rbw_filter_bandwidth(self, selector_string):
r"""Gets the RBW Filter Bandwidth in Hz
The default value is 500 kHz
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (float):
Specifies the RBW Filter Bandwidth in Hz
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_f64(
updated_selector_string, attributes.AttributeID.PVT_RBW_FILTER_BANDWIDTH.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_rbw_filter_bandwidth(self, selector_string, value):
r"""Sets the RBW Filter Bandwidth in Hz
The default value is 500 kHz
Args:
selector_string (string):
Pass an empty string.
value (float):
Specifies the RBW Filter Bandwidth in Hz
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_f64(
updated_selector_string,
attributes.AttributeID.PVT_RBW_FILTER_BANDWIDTH.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_maximum_power_trace_enabled(self, selector_string):
r"""Gets whether the maximum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the peak power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Maximum Power Trace** method to fetch the maximum power trace.
This attribute is applicable only when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_TYPE` attribute to **RMS** or **Log**.
The default value is FALSE.
+--------------+------------------------------------------------------+
| Name (Value) | Description |
+==============+======================================================+
| False (0) | Disables computation of the PVT Maximum Power Trace. |
+--------------+------------------------------------------------------+
| True (1) | Enables computation of the PVT Maximum Power Trace. |
+--------------+------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.PvtMaximumPowerTraceEnabled):
Specifies whether the maximum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the peak power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Maximum Power Trace** method to fetch the maximum power trace.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_MAXIMUM_POWER_TRACE_ENABLED.value,
)
attr_val = enums.PvtMaximumPowerTraceEnabled(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_maximum_power_trace_enabled(self, selector_string, value):
r"""Sets whether the maximum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the peak power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Maximum Power Trace** method to fetch the maximum power trace.
This attribute is applicable only when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_TYPE` attribute to **RMS** or **Log**.
The default value is FALSE.
+--------------+------------------------------------------------------+
| Name (Value) | Description |
+==============+======================================================+
| False (0) | Disables computation of the PVT Maximum Power Trace. |
+--------------+------------------------------------------------------+
| True (1) | Enables computation of the PVT Maximum Power Trace. |
+--------------+------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.PvtMaximumPowerTraceEnabled, int):
Specifies whether the maximum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the peak power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Maximum Power Trace** method to fetch the maximum power trace.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.PvtMaximumPowerTraceEnabled else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_MAXIMUM_POWER_TRACE_ENABLED.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_minimum_power_trace_enabled(self, selector_string):
r"""Gets whether the minimum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the lowest power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Minimum Power Trace** method to fetch the minimum power trace.
This attribute is applicable only when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_TYPE` attribute to **RMS** or **Log**.
The default value is FALSE.
+--------------+------------------------------------------------------+
| Name (Value) | Description |
+==============+======================================================+
| False (0) | Disables computation of the PVT Minimum Power Trace. |
+--------------+------------------------------------------------------+
| True (1) | Enables computation of the PVT Minimum Power Trace. |
+--------------+------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (enums.PvtMinimumPowerTraceEnabled):
Specifies whether the minimum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the lowest power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Minimum Power Trace** method to fetch the minimum power trace.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_MINIMUM_POWER_TRACE_ENABLED.value,
)
attr_val = enums.PvtMinimumPowerTraceEnabled(attr_val)
except (KeyError, ValueError):
raise errors.DriverTooNewError() # type: ignore
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_minimum_power_trace_enabled(self, selector_string, value):
r"""Sets whether the minimum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the lowest power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Minimum Power Trace** method to fetch the minimum power trace.
This attribute is applicable only when you set the
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_TYPE` attribute to **RMS** or **Log**.
The default value is FALSE.
+--------------+------------------------------------------------------+
| Name (Value) | Description |
+==============+======================================================+
| False (0) | Disables computation of the PVT Minimum Power Trace. |
+--------------+------------------------------------------------------+
| True (1) | Enables computation of the PVT Minimum Power Trace. |
+--------------+------------------------------------------------------+
Args:
selector_string (string):
Pass an empty string.
value (enums.PvtMinimumPowerTraceEnabled, int):
Specifies whether the minimum power trace is enabled. When
:py:attr:`~nirfmxgsm.attributes.AttributeID.PVT_AVERAGING_ENABLED` attribute is set to **True**, the lowest power at
each sample interval is retained from one acquisition to the next acquisition. You can use the **RFmxGSM PVT Fetch
Minimum Power Trace** method to fetch the minimum power trace.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
value = value.value if type(value) is enums.PvtMinimumPowerTraceEnabled else value
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_MINIMUM_POWER_TRACE_ENABLED.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_all_traces_enabled(self, selector_string):
r"""Gets whether to enable the traces to be stored and retrieved after performing the power versus time (PVT)
measurement.
The default value is FALSE.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (bool):
Specifies whether to enable the traces to be stored and retrieved after performing the power versus time (PVT)
measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_ALL_TRACES_ENABLED.value
)
attr_val = bool(attr_val)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_all_traces_enabled(self, selector_string, value):
r"""Sets whether to enable the traces to be stored and retrieved after performing the power versus time (PVT)
measurement.
The default value is FALSE.
Args:
selector_string (string):
Pass an empty string.
value (bool):
Specifies whether to enable the traces to be stored and retrieved after performing the power versus time (PVT)
measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_ALL_TRACES_ENABLED.value,
int(value),
)
finally:
self._session_function_lock.exit_read_lock()
return error_code
[docs]
@_raise_if_disposed
def get_number_of_analysis_threads(self, selector_string):
r"""Gets the maximum number of threads used for parallelism for the power versus time (PVT) measurement.
The number of threads can range from 1 to the number of physical cores. The number of threads you set may not
be used in calculations. The actual number of threads used depends on the problem size, system resources, data
availability, and other considerations.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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.
Args:
selector_string (string):
Pass an empty string.
Returns:
Tuple (attr_val, error_code):
attr_val (int):
Specifies the maximum number of threads used for parallelism for the power versus time (PVT) measurement.
error_code (int):
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
attr_val, error_code = self._interpreter.get_attribute_i32(
updated_selector_string, attributes.AttributeID.PVT_NUMBER_OF_ANALYSIS_THREADS.value
)
finally:
self._session_function_lock.exit_read_lock()
return attr_val, error_code
[docs]
@_raise_if_disposed
def set_number_of_analysis_threads(self, selector_string, value):
r"""Sets the maximum number of threads used for parallelism for the power versus time (PVT) measurement.
The number of threads can range from 1 to the number of physical cores. The number of threads you set may not
be used in calculations. The actual number of threads used depends on the problem size, system resources, data
availability, and other considerations.
You do not need to use a `Selector String
<https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_ 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.
Args:
selector_string (string):
Pass an empty string.
value (int):
Specifies the maximum number of threads used for parallelism for the power versus time (PVT) measurement.
Returns:
int:
Returns the status code of this method. The status code either indicates success or describes a warning condition.
"""
try:
self._session_function_lock.enter_read_lock()
updated_selector_string = _helper.validate_and_update_selector_string(
selector_string, self._signal_obj
)
error_code = self._interpreter.set_attribute_i32(
updated_selector_string,
attributes.AttributeID.PVT_NUMBER_OF_ANALYSIS_THREADS.value,
value,
)
finally:
self._session_function_lock.exit_read_lock()
return error_code