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

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ...... import enums


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

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

	@property
	def apply(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_apply'):
			from .Apply import ApplyCls
			self._apply = ApplyCls(self._core, self._cmd_group)
		return self._apply

	@property
	def device(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_device'):
			from .Device import DeviceCls
			self._device = DeviceCls(self._core, self._cmd_group)
		return self._device

	@property
	def remove(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_remove'):
			from .Remove import RemoveCls
			self._remove = RemoveCls(self._core, self._cmd_group)
		return self._remove

[docs] def get_alias(self) -> str: """ ``SCONfiguration:EXTernal:REMote:EDIT:ALIas`` \n Snippet: ``value: str = driver.sconfiguration.external.remote.edit.get_alias()`` \n No help available """ response = self._core.io.query_str('SCONfiguration:EXTernal:REMote:EDIT:ALIas?') return trim_str_response(response)
[docs] def set_alias(self, symbolic_name: str) -> None: """ ``SCONfiguration:EXTernal:REMote:EDIT:ALIas`` \n Snippet: ``driver.sconfiguration.external.remote.edit.set_alias(symbolic_name = 'abc')`` \n No help available """ param = Conversions.value_to_quoted_str(symbolic_name) self._core.io.write(f'SCONfiguration:EXTernal:REMote:EDIT:ALIas {param}')
[docs] def get_hostname(self) -> str: """ ``SCONfiguration:EXTernal:REMote:EDIT:HOSTname`` \n Snippet: ``value: str = driver.sconfiguration.external.remote.edit.get_hostname()`` \n No help available """ response = self._core.io.query_str('SCONfiguration:EXTernal:REMote:EDIT:HOSTname?') return trim_str_response(response)
[docs] def set_hostname(self, hostname_or_ip: str) -> None: """ ``SCONfiguration:EXTernal:REMote:EDIT:HOSTname`` \n Snippet: ``driver.sconfiguration.external.remote.edit.set_hostname(hostname_or_ip = 'abc')`` \n No help available """ param = Conversions.value_to_quoted_str(hostname_or_ip) self._core.io.write(f'SCONfiguration:EXTernal:REMote:EDIT:HOSTname {param}')
[docs] def get_iselect(self) -> str: """ ``SCONfiguration:EXTernal:REMote:EDIT:ISELect`` \n Snippet: ``value: str = driver.sconfiguration.external.remote.edit.get_iselect()`` \n No help available """ response = self._core.io.query_str('SCONfiguration:EXTernal:REMote:EDIT:ISELect?') return trim_str_response(response)
[docs] def set_iselect(self, instrument_name: str) -> None: """ ``SCONfiguration:EXTernal:REMote:EDIT:ISELect`` \n Snippet: ``driver.sconfiguration.external.remote.edit.set_iselect(instrument_name = 'abc')`` \n No help available """ param = Conversions.value_to_quoted_str(instrument_name) self._core.io.write(f'SCONfiguration:EXTernal:REMote:EDIT:ISELect {param}')
# noinspection PyTypeChecker
[docs] def get_rchannel(self) -> enums.RcConnType: """ ``SCONfiguration:EXTernal:REMote:EDIT:RCHannel`` \n Snippet: ``value: enums.RcConnType = driver.sconfiguration.external.remote.edit.get_rchannel()`` \n No help available """ response = self._core.io.query_str('SCONfiguration:EXTernal:REMote:EDIT:RCHannel?') return Conversions.str_to_scalar_enum(response, enums.RcConnType)
[docs] def set_rchannel(self, remote_channel: enums.RcConnType) -> None: """ ``SCONfiguration:EXTernal:REMote:EDIT:RCHannel`` \n Snippet: ``driver.sconfiguration.external.remote.edit.set_rchannel(remote_channel = enums.RcConnType.FRONtend)`` \n No help available """ param = Conversions.enum_scalar_to_str(remote_channel, enums.RcConnType) self._core.io.write(f'SCONfiguration:EXTernal:REMote:EDIT:RCHannel {param}')
[docs] def get_serial(self) -> int: """ ``SCONfiguration:EXTernal:REMote:EDIT:SERial`` \n Snippet: ``value: int = driver.sconfiguration.external.remote.edit.get_serial()`` \n No help available """ response = self._core.io.query_str('SCONfiguration:EXTernal:REMote:EDIT:SERial?') return Conversions.str_to_int(response)
[docs] def set_serial(self, serial_number: int) -> None: """ ``SCONfiguration:EXTernal:REMote:EDIT:SERial`` \n Snippet: ``driver.sconfiguration.external.remote.edit.set_serial(serial_number = 1)`` \n No help available """ param = Conversions.decimal_value_to_str(serial_number) self._core.io.write(f'SCONfiguration:EXTernal:REMote:EDIT:SERial {param}')
def clone(self) -> 'EditCls': """ 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 = EditCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group