from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs]
def set(self, value: bool, refLevel=repcap.RefLevel.Default) -> None:
"""
``REFLevel<*>:AUTO[:STATe]`` \n
Snippet: ``driver.refLevel.auto.state.set(value = False, refLevel = repcap.RefLevel.Default)`` \n
Enables averaging over several histograms to determine the reference levels. The number of histograms to consider is
defined using method ``RsRtx.refLevel.auto.count.set()`` . This function is only available in automatic reference level
mode (see method ``RsRtx.refLevel.ldetection.set()`` ) .
:param value: OFF | ON
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
"""
param = Conversions.bool_to_str(value)
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
self._core.io.write_with_opc(f'REFLevel{refLevel_cmd_val}:AUTO:STATe {param}')
[docs]
def get(self, refLevel=repcap.RefLevel.Default) -> bool:
"""
``REFLevel<*>:AUTO[:STATe]`` \n
Snippet: ``value: bool = driver.refLevel.auto.state.get(refLevel = repcap.RefLevel.Default)`` \n
Enables averaging over several histograms to determine the reference levels. The number of histograms to consider is
defined using method ``RsRtx.refLevel.auto.count.set()`` . This function is only available in automatic reference level
mode (see method ``RsRtx.refLevel.ldetection.set()`` ) .
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
:return: value: OFF | ON
"""
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
response = self._core.io.query_str_with_opc(f'REFLevel{refLevel_cmd_val}:AUTO:STATe?')
return Conversions.str_to_bool(response)