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, marker=repcap.Marker.Default) -> None:
"""SCPI: CALCulate<n>:MARKer<m>:FUNCtion:AFPHase[:STATe] \n
Snippet: driver.calculate.marker.function.afPhase.state.set(state = False, window = repcap.Window.Default, marker = repcap.Marker.Default) \n
Is only available for AF spectrum result displays. If enabled, the phase value at each marker position is included in the
marker table. The function is always enabled for all active markers in the selected display, it cannot be disabled for
individual markers. \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 marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
"""
param = Conversions.bool_to_str(state)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
self._core.io.write(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:FUNCtion:AFPHase:STATe {param}')
[docs] def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> bool:
"""SCPI: CALCulate<n>:MARKer<m>:FUNCtion:AFPHase[:STATe] \n
Snippet: value: bool = driver.calculate.marker.function.afPhase.state.get(window = repcap.Window.Default, marker = repcap.Marker.Default) \n
Is only available for AF spectrum result displays. If enabled, the phase value at each marker position is included in the
marker table. The function is always enabled for all active markers in the selected display, it cannot be disabled for
individual markers. \n
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
: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)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:FUNCtion:AFPHase:STATe?')
return Conversions.str_to_bool(response)