from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CouplingCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("coupling", core, parent)
[docs]
def set(self, state: bool, window=repcap.Window.Default, marker=repcap.Marker.Default) -> None:
"""
``CALCulate<n>:MARKer<m>:COUPling`` \n
Snippet: ``driver.applications.k14Xnr5G.calculate.marker.coupling.set(state = False, window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n
Couples or decouples markers in different result displays to each other.
:param state: ON | OFF | 1 | 0
: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}:COUPling {param}')
[docs]
def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> bool:
"""
``CALCulate<n>:MARKer<m>:COUPling`` \n
Snippet: ``value: bool = driver.applications.k14Xnr5G.calculate.marker.coupling.get(window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n
Couples or decouples markers in different result displays to each other.
: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 | 1 | 0
"""
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}:COUPling?')
return Conversions.str_to_bool(response)