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 ShLabelsCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("shLabels", core, parent)
[docs]
def set(self, meas_type: enums.MeasSpectrumParam, state: bool, measurement=repcap.Measurement.Default) -> None:
"""
``MEASurement<*>:RESult:SHLabels`` \n
Snippet: ``driver.measurement.result.shLabels.set(meas_type = enums.MeasSpectrumParam.ACPower, state = False, measurement = repcap.Measurement.Default)`` \n
Defines whether a description (label) is displayed for each detected peak in the spectrum diagram. The layout of the
label is defined by method ``RsRtx.measurement.result.labOrder.set()`` .
:param meas_type: Only for peaklist measurements. For other measurements, this command returns an error.
:param state: ON | OFF
: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.MeasSpectrumParam), ArgSingle('state', state, DataType.Boolean))
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
self._core.io.write(f'MEASurement{measurement_cmd_val}:RESult:SHLabels {param}'.rstrip())
[docs]
def get(self, meas_type: enums.MeasSpectrumParam, measurement=repcap.Measurement.Default) -> bool:
"""
``MEASurement<*>:RESult:SHLabels`` \n
Snippet: ``value: bool = driver.measurement.result.shLabels.get(meas_type = enums.MeasSpectrumParam.ACPower, measurement = repcap.Measurement.Default)`` \n
Defines whether a description (label) is displayed for each detected peak in the spectrum diagram. The layout of the
label is defined by method ``RsRtx.measurement.result.labOrder.set()`` .
:param meas_type: Only for peaklist measurements. For other measurements, this command returns an error.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:return: state: ON | OFF
"""
param = Conversions.enum_scalar_to_str(meas_type, enums.MeasSpectrumParam)
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
response = self._core.io.query_str(f'MEASurement{measurement_cmd_val}:RESult:SHLabels? {param}')
return Conversions.str_to_bool(response)