Source code for RsSmw.Implementations.Sconfiguration.External.Coder.Rconnection.State

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("state", core, parent)

[docs] def get(self, index=repcap.Index.Default) -> bool: """ ``SCONfiguration:EXTernal:CODer<CH>:RCONnection:STATe`` \n Snippet: ``value: bool = driver.sconfiguration.external.coder.rconnection.state.get(index = repcap.Index.Default)`` \n Queries the status of the remote connection. :param index: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Coder') :return: state: 1 | ON | 0| OFF """ index_cmd_val = self._cmd_group.get_repcap_cmd_value(index, repcap.Index) response = self._core.io.query_str(f'SCONfiguration:EXTernal:CODer{index_cmd_val}:RCONnection:STATe?') return Conversions.str_to_bool(response)