Source code for RsFsw.Implementations.Applications.K14x_Nr5G.Display.Window.Subwindow.Trace.State

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, subWindow=repcap.SubWindow.Default, trace=repcap.Trace.Default) -> None: """SCPI: DISPlay[:WINDow<n>][:SUBWindow<w>]:TRACe<t>[:STATe] \n Snippet: driver.applications.k14Xnr5G.display.window.subwindow.trace.state.set(state = False, window = repcap.Window.Default, subWindow = repcap.SubWindow.Default, trace = repcap.Trace.Default) \n Turns a trace on and off. The measurement continues in the background. \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 'Window') :param subWindow: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Subwindow') :param trace: optional repeated capability selector. Default value: Tr1 (settable in the interface 'Trace') """ param = Conversions.bool_to_str(state) window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) subWindow_cmd_val = self._cmd_group.get_repcap_cmd_value(subWindow, repcap.SubWindow) trace_cmd_val = self._cmd_group.get_repcap_cmd_value(trace, repcap.Trace) self._core.io.write(f'DISPlay:WINDow{window_cmd_val}:SUBWindow{subWindow_cmd_val}:TRACe{trace_cmd_val}:STATe {param}')
[docs] def get(self, window=repcap.Window.Default, subWindow=repcap.SubWindow.Default, trace=repcap.Trace.Default) -> bool: """SCPI: DISPlay[:WINDow<n>][:SUBWindow<w>]:TRACe<t>[:STATe] \n Snippet: value: bool = driver.applications.k14Xnr5G.display.window.subwindow.trace.state.get(window = repcap.Window.Default, subWindow = repcap.SubWindow.Default, trace = repcap.Trace.Default) \n Turns a trace on and off. The measurement continues in the background. \n :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Window') :param subWindow: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Subwindow') :param trace: optional repeated capability selector. Default value: Tr1 (settable in the interface 'Trace') :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) subWindow_cmd_val = self._cmd_group.get_repcap_cmd_value(subWindow, repcap.SubWindow) trace_cmd_val = self._cmd_group.get_repcap_cmd_value(trace, repcap.Trace) response = self._core.io.query_str(f'DISPlay:WINDow{window_cmd_val}:SUBWindow{subWindow_cmd_val}:TRACe{trace_cmd_val}:STATe?') return Conversions.str_to_bool(response)