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

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


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

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

[docs] def set(self) -> None: """ ``SCONfiguration:EXTernal:REMote:CLEan`` \n Snippet: ``driver.sconfiguration.external.remote.clean.set()`` \n Removes all instruments from the pool of external instruments. """ self._core.io.write(f'SCONfiguration:EXTernal:REMote:CLEan')
[docs] def set_with_opc(self, opc_timeout_ms: int = -1) -> None: """ ``SCONfiguration:EXTernal:REMote:CLEan`` \n Snippet: ``driver.sconfiguration.external.remote.clean.set_with_opc()`` \n Removes all instruments from the pool of external instruments. Same as set, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value. :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'SCONfiguration:EXTernal:REMote:CLEan', opc_timeout_ms)