from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SscreenCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("sscreen", core, parent)
[docs]
def set(self, cursor=repcap.Cursor.Default) -> None:
"""
``CURSor<*>:SSCReen`` \n
Snippet: ``driver.cursor.sscreen.set(cursor = repcap.Cursor.Default)`` \n
Resets the cursors to their initial positions. Reset is helpful if the cursors have disappeared from the display or need
to be moved for a larger distance.
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
"""
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
self._core.io.write(f'CURSor{cursor_cmd_val}:SSCReen')
[docs]
def set_and_wait(self, cursor=repcap.Cursor.Default, opc_timeout_ms: int = -1) -> None:
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
"""
``CURSor<*>:SSCReen`` \n
Snippet: ``driver.cursor.sscreen.set_and_wait(cursor = repcap.Cursor.Default)`` \n
Resets the cursors to their initial positions. Reset is helpful if the cursors have disappeared from the display or need
to be moved for a larger distance.
Same as set, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value.
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'CURSor{cursor_cmd_val}:SSCReen', opc_timeout_ms)