from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class StateCls:
"""State commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
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, freqLine=repcap.FreqLine.Default) -> None:
"""SCPI: CALCulate<n>:FLINe<li>:STATe \n
Snippet: driver.applications.k14Xnr5G.calculate.fline.state.set(state = False, window = repcap.Window.Default, freqLine = repcap.FreqLine.Default) \n
Turns a frequency line on and off \n
: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 freqLine: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Fline')
"""
param = Conversions.bool_to_str(state)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
freqLine_cmd_val = self._cmd_group.get_repcap_cmd_value(freqLine, repcap.FreqLine)
self._core.io.write(f'CALCulate{window_cmd_val}:FLINe{freqLine_cmd_val}:STATe {param}')
[docs] def get(self, window=repcap.Window.Default, freqLine=repcap.FreqLine.Default) -> bool:
"""SCPI: CALCulate<n>:FLINe<li>:STATe \n
Snippet: value: bool = driver.applications.k14Xnr5G.calculate.fline.state.get(window = repcap.Window.Default, freqLine = repcap.FreqLine.Default) \n
Turns a frequency line on and off \n
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param freqLine: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Fline')
: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)
freqLine_cmd_val = self._cmd_group.get_repcap_cmd_value(freqLine, repcap.FreqLine)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:FLINe{freqLine_cmd_val}:STATe?')
return Conversions.str_to_bool(response)