Source code for RsSmw.Implementations.Sconfiguration.External.Coder.Remote.Iconnect

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.Types import DataType
from ......Internal.ArgSingleList import ArgSingleList
from ......Internal.ArgSingle import ArgSingle
from ...... import repcap


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

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

[docs] def set(self, instr_name: str, rf_path: str, index=repcap.Index.Default) -> None: """ ``SCONfiguration:EXTernal:CODer<CH>:REMote:ICONnect`` \n Snippet: ``driver.sconfiguration.external.coder.remote.iconnect.set(instr_name = 'abc', rf_path = 'abc', index = repcap.Index.Default)`` \n Selects an external instrument for the selected connector and triggers connection. :param instr_name: string Instrument alias name, as retrieved with the method ``RsSmw.sconfiguration.external.remote.list_py()`` . The name can also be defined with the method ``RsSmw.sconfiguration.external.remote.add.set()`` . :param rf_path: string Determines the used RF output of the external instrument. :param index: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Coder') """ param = ArgSingleList().compose_cmd_string(ArgSingle('instr_name', instr_name, DataType.String), ArgSingle('rf_path', rf_path, DataType.String)) index_cmd_val = self._cmd_group.get_repcap_cmd_value(index, repcap.Index) self._core.io.write(f'SCONfiguration:EXTernal:CODer{index_cmd_val}:REMote:ICONnect {param}'.rstrip())