from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class SelectCls:
"""Select commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("select", core, parent)
[docs] def set(self, window=repcap.Window.Default, subWindow=repcap.SubWindow.Default, trace=repcap.Trace.Default) -> None:
"""SCPI: DISPlay[:WINDow<n>][:SUBWindow<w>]:TRACe<t>:SELect \n
Snippet: driver.display.window.subwindow.trace.select.set(window = repcap.Window.Default, subWindow = repcap.SubWindow.Default, trace = repcap.Trace.Default) \n
Selects the trace specified by the index <t> in the window specified by the index <n>. Only traces that are active in the
specified result display can be selected. The selected trace is used to determine the 'Result Summary' for the
corresponding result display. The query returns the number of the currently selected trace in the window specified by the
index <n> (trace index is ignored) . Traces can only be queried for graphical result displays (not 'Result Summary',
'Marker Table' or Peak Marker List) . \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')
"""
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}:SELect')
[docs] def set_with_opc(self, window=repcap.Window.Default, subWindow=repcap.SubWindow.Default, trace=repcap.Trace.Default, opc_timeout_ms: int = -1) -> None:
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)
"""SCPI: DISPlay[:WINDow<n>][:SUBWindow<w>]:TRACe<t>:SELect \n
Snippet: driver.display.window.subwindow.trace.select.set_with_opc(window = repcap.Window.Default, subWindow = repcap.SubWindow.Default, trace = repcap.Trace.Default) \n
Selects the trace specified by the index <t> in the window specified by the index <n>. Only traces that are active in the
specified result display can be selected. The selected trace is used to determine the 'Result Summary' for the
corresponding result display. The query returns the number of the currently selected trace in the window specified by the
index <n> (trace index is ignored) . Traces can only be queried for graphical result displays (not 'Result Summary',
'Marker Table' or Peak Marker List) . \n
Same as set, but waits for the operation to complete before continuing further. Use the RsFsw.utilities.opc_timeout_set() to set the timeout value. \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')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'DISPlay:WINDow{window_cmd_val}:SUBWindow{subWindow_cmd_val}:TRACe{trace_cmd_val}:SELect', opc_timeout_ms)