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 get(self, timingReference=repcap.TimingReference.Default) -> bool:
"""
``TREFerence<*>:STATe`` \n
Snippet: ``value: bool = driver.treference.state.get(timingReference = repcap.TimingReference.Default)`` \n
Returns if the specified timing reference is used by an application, e.g. by jitter measurements.
:param timingReference: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Treference')
:return: state: OFF | ON
"""
timingReference_cmd_val = self._cmd_group.get_repcap_cmd_value(timingReference, repcap.TimingReference)
response = self._core.io.query_str(f'TREFerence{timingReference_cmd_val}:STATe?')
return Conversions.str_to_bool(response)