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

from typing import List

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class RemoteCls:
	"""
	| Commands in total: 20
	| Subgroups: 8
	| Direct child commands: 3
	"""

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

	@property
	def add(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_add'):
			from .Add import AddCls
			self._add = AddCls(self._core, self._cmd_group)
		return self._add

	@property
	def clean(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_clean'):
			from .Clean import CleanCls
			self._clean = CleanCls(self._core, self._cmd_group)
		return self._clean

	@property
	def connect(self):
		"""
		| Commands in total: 1
		| Subgroups: 1
		| Direct child commands: 0
		"""
		if not hasattr(self, '_connect'):
			from .Connect import ConnectCls
			self._connect = ConnectCls(self._core, self._cmd_group)
		return self._connect

	@property
	def disconnect(self):
		"""
		| Commands in total: 1
		| Subgroups: 1
		| Direct child commands: 0
		"""
		if not hasattr(self, '_disconnect'):
			from .Disconnect import DisconnectCls
			self._disconnect = DisconnectCls(self._core, self._cmd_group)
		return self._disconnect

	@property
	def edit(self):
		"""
		| Commands in total: 8
		| Subgroups: 3
		| Direct child commands: 5
		"""
		if not hasattr(self, '_edit'):
			from .Edit import EditCls
			self._edit = EditCls(self._core, self._cmd_group)
		return self._edit

	@property
	def initialization(self):
		"""
		| Commands in total: 2
		| Subgroups: 1
		| Direct child commands: 1
		"""
		if not hasattr(self, '_initialization'):
			from .Initialization import InitializationCls
			self._initialization = InitializationCls(self._core, self._cmd_group)
		return self._initialization

	@property
	def purge(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_purge'):
			from .Purge import PurgeCls
			self._purge = PurgeCls(self._core, self._cmd_group)
		return self._purge

	@property
	def scan(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_scan'):
			from .Scan import ScanCls
			self._scan = ScanCls(self._core, self._cmd_group)
		return self._scan

[docs] def delete(self, id_pi_db_ext_dev_rem_inst_remove: List[str]) -> None: """ ``SCONfiguration:EXTernal:REMote:DELete`` \n Snippet: ``driver.sconfiguration.external.remote.delete(id_pi_db_ext_dev_rem_inst_remove = ['abc1', 'abc2', 'abc3'])`` \n No help available """ param = Conversions.list_to_csv_quoted_str(id_pi_db_ext_dev_rem_inst_remove) self._core.io.write(f'SCONfiguration:EXTernal:REMote:DELete {param}')
[docs] def get_list_py(self) -> List[str]: """ ``SCONfiguration:EXTernal:REMote:LIST`` \n Snippet: ``value: List[str] = driver.sconfiguration.external.remote.get_list_py()`` \n Lists all available instruments. Instruments found, e.g. by the method ``RsSmw.sconfiguration.external.remote.scan.set()`` command. :return: instr_names: String String with symbolic names and/or alias names """ response = self._core.io.query_str('SCONfiguration:EXTernal:REMote:LIST?') return Conversions.str_to_str_list(response)
[docs] def set_rename(self, id_pi_db_rem_inst_rename: List[str]) -> None: """ ``SCONfiguration:EXTernal:REMote:REName`` \n Snippet: ``driver.sconfiguration.external.remote.set_rename(id_pi_db_rem_inst_rename = ['abc1', 'abc2', 'abc3'])`` \n Changes the symbolic name of the instrument. """ param = Conversions.list_to_csv_quoted_str(id_pi_db_rem_inst_rename) self._core.io.write(f'SCONfiguration:EXTernal:REMote:REName {param}')
def clone(self) -> 'RemoteCls': """ Clones the group by creating new object from it and its whole existing subgroups. Also copies all the existing default Repeated Capabilities setting, which you can change independently without affecting the original group. """ new_group = RemoteCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group