Source code for RsSmbv.Implementations.Sconfiguration.External.Digital.Remote.Iselect

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class IselectCls:
	"""Iselect commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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

	def set(self, instr_name: str, rf_path: str = None, index=repcap.Index.Default) -> None:
		"""SCPI: SCONfiguration:EXTernal:DIGital<CH>:REMote:ISELect \n
		Snippet: driver.sconfiguration.external.digital.remote.iselect.set(instr_name = 'abc', rf_path = 'abc', index = repcap.Index.Default) \n
		Select an external instrument for the selected connector. \n
			:param instr_name: String Instrument alias name, as retrieved with the command method RsSmbv.Sconfiguration.External.Remote.listPy or defined with the command method RsSmbv.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 'Digital')
		"""
		param = ArgSingleList().compose_cmd_string(ArgSingle('instr_name', instr_name, DataType.String), ArgSingle('rf_path', rf_path, DataType.String, None, is_optional=True))
		index_cmd_val = self._cmd_group.get_repcap_cmd_value(index, repcap.Index)
		self._core.io.write(f'SCONfiguration:EXTernal:DIGital{index_cmd_val}:REMote:ISELect {param}'.rstrip())

	# noinspection PyTypeChecker
	class IselectStruct(StructBase):
		"""Response structure. Fields: \n
			- Instr_Name: str: String Instrument alias name, as retrieved with the command [CMDLINKRESOLVED Sconfiguration.External.Remote#ListPy CMDLINKRESOLVED] or defined with the command [CMDLINKRESOLVED Sconfiguration.External.Remote.Add#set CMDLINKRESOLVED].
			- Rf_Path: str: String Determines the used RF output of the external instrument."""
		__meta_args_list = [
			ArgStruct.scalar_str('Instr_Name'),
			ArgStruct.scalar_str('Rf_Path')]

		def __init__(self):
			StructBase.__init__(self, self)
			self.Instr_Name: str = None
			self.Rf_Path: str = None

	def get(self, index=repcap.Index.Default) -> IselectStruct:
		"""SCPI: SCONfiguration:EXTernal:DIGital<CH>:REMote:ISELect \n
		Snippet: value: IselectStruct = driver.sconfiguration.external.digital.remote.iselect.get(index = repcap.Index.Default) \n
		Select an external instrument for the selected connector. \n
			:param index: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Digital')
			:return: structure: for return value, see the help for IselectStruct structure arguments."""
		index_cmd_val = self._cmd_group.get_repcap_cmd_value(index, repcap.Index)
		return self._core.io.query_struct(f'SCONfiguration:EXTernal:DIGital{index_cmd_val}:REMote:ISELect?', self.__class__.IselectStruct())