from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ...Internal.Types import DataType
from ...Internal.ArgSingleList import ArgSingleList
from ...Internal.ArgSingle import ArgSingle
from ... import enums
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class AdditionalCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("additional", core, parent)
[docs]
def set(self, meas_type: enums.MeasurementType, state: bool, measurement=repcap.Measurement.Default) -> None:
"""
``MEASurement<*>:ADDitional`` \n
Snippet: ``driver.measurement.additional.set(meas_type = enums.MeasurementType.ACPower, state = False, measurement = repcap.Measurement.Default)`` \n
Adds additional measurements to the indicated measurement group. Only one measurement can be enabled or disabled per
command. The query returns the state of the specified measurement. Note that each measurement group must contain
measurements from the same category. For example, if the main measurement of measurement group 1 is amplitude, then you
cannot enable an eye width measurement in the same measurement group.
:param meas_type: See method ``RsRtx.measurement.main.set()``.
:param state: Enables or disables the measurement.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('meas_type', meas_type, DataType.Enum, enums.MeasurementType), ArgSingle('state', state, DataType.Boolean))
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
self._core.io.write_with_opc(f'MEASurement{measurement_cmd_val}:ADDitional {param}'.rstrip())
[docs]
def get(self, meas_type: enums.MeasurementType, measurement=repcap.Measurement.Default) -> bool:
"""
``MEASurement<*>:ADDitional`` \n
Snippet: ``value: bool = driver.measurement.additional.get(meas_type = enums.MeasurementType.ACPower, measurement = repcap.Measurement.Default)`` \n
Adds additional measurements to the indicated measurement group. Only one measurement can be enabled or disabled per
command. The query returns the state of the specified measurement. Note that each measurement group must contain
measurements from the same category. For example, if the main measurement of measurement group 1 is amplitude, then you
cannot enable an eye width measurement in the same measurement group.
:param meas_type: See method ``RsRtx.measurement.main.set()``.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:return: state: Enables or disables the measurement.
"""
param = Conversions.enum_scalar_to_str(meas_type, enums.MeasurementType)
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
response = self._core.io.query_str_with_opc(f'MEASurement{measurement_cmd_val}:ADDitional? {param}')
return Conversions.str_to_bool(response)