from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DisconnectCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("disconnect", core, parent)
[docs]
def set(self, index=repcap.Index.Default) -> None:
"""
``SCONfiguration:EXTernal:CODer<CH>:REMote:DISConnect`` \n
Snippet: ``driver.sconfiguration.external.coder.remote.disconnect.set(index = repcap.Index.Default)`` \n
Disconnects the selected remote connection. To disconnect all remote connections at once, use the command method
``RsSmw.sconfiguration.external.remote.disconnect.all.set()`` .
:param index: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Coder')
"""
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:DISConnect')
[docs]
def set_with_opc(self, index=repcap.Index.Default, opc_timeout_ms: int = -1) -> None:
index_cmd_val = self._cmd_group.get_repcap_cmd_value(index, repcap.Index)
"""
``SCONfiguration:EXTernal:CODer<CH>:REMote:DISConnect`` \n
Snippet: ``driver.sconfiguration.external.coder.remote.disconnect.set_with_opc(index = repcap.Index.Default)`` \n
Disconnects the selected remote connection. To disconnect all remote connections at once, use the command method
``RsSmw.sconfiguration.external.remote.disconnect.all.set()`` .
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 index: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Coder')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'SCONfiguration:EXTernal:CODer{index_cmd_val}:REMote:DISConnect', opc_timeout_ms)