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, state: bool, window=repcap.Window.Default) -> None:
"""
``CALCulate<n>:SPECtrogram:TSTamp[:STATe]`` \n
Snippet: ``driver.calculate.spectrogram.tstamp.state.set(state = False, window = repcap.Window.Default)`` \n
Activates and deactivates the time stamp. If the time stamp is active, some commands do not address frames as numbers,
but as (relative) time values:
Note: \n
- method ``RsFsw.calculate.deltaMarker.spectrogram.frame.set()``
- method ``RsFsw.calculate.marker.spectrogram.frame.set()``
- method ``RsFsw.calculate.spectrogram.frame.select.set()``
:param state: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = Conversions.bool_to_str(state)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:SPECtrogram:TSTamp:STATe {param}')
[docs]
def get(self, window=repcap.Window.Default) -> bool:
"""
``CALCulate<n>:SPECtrogram:TSTamp[:STATe]`` \n
Snippet: ``value: bool = driver.calculate.spectrogram.tstamp.state.get(window = repcap.Window.Default)`` \n
Activates and deactivates the time stamp. If the time stamp is active, some commands do not address frames as numbers,
but as (relative) time values:
Note: \n
- method ``RsFsw.calculate.deltaMarker.spectrogram.frame.set()``
- method ``RsFsw.calculate.marker.spectrogram.frame.set()``
- method ``RsFsw.calculate.spectrogram.frame.select.set()``
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: state: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:SPECtrogram:TSTamp:STATe?')
return Conversions.str_to_bool(response)