Source code for RsFsw.Implementations.Applications.K70_Vsa.Calculate.DlRel.State

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
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)

	def set(self, state: bool, window=repcap.Window.Default) -> None:
		"""SCPI: CALCulate<n>:DLRel:STATe \n
		Snippet: driver.applications.k70Vsa.calculate.dlRel.state.set(state = False, window = repcap.Window.Default) \n
		Displays a relative horizontal line in the specified window. This command is only available for eye diagrams, and only if
		an absolute horizontal line is already available in the same diagram (see method RsFsw.Applications.K70_Vsa.Calculate.
		Dlabs.State.set) . \n
			:param state: ON | OFF | 1 | 0
			:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
		"""
		param = Conversions.bool_to_str(state)
		window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
		self._core.io.write(f'CALCulate{window_cmd_val}:DLRel:STATe {param}')

	def get(self, window=repcap.Window.Default) -> bool:
		"""SCPI: CALCulate<n>:DLRel:STATe \n
		Snippet: value: bool = driver.applications.k70Vsa.calculate.dlRel.state.get(window = repcap.Window.Default) \n
		Displays a relative horizontal line in the specified window. This command is only available for eye diagrams, and only if
		an absolute horizontal line is already available in the same diagram (see method RsFsw.Applications.K70_Vsa.Calculate.
		Dlabs.State.set) . \n
			:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
			:return: state: ON | OFF | 1 | 0"""
		window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
		response = self._core.io.query_str(f'CALCulate{window_cmd_val}:DLRel:STATe?')
		return Conversions.str_to_bool(response)