from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class RemoveCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("remove", core, parent)
[docs]
def set(self, annotation=repcap.Annotation.Default) -> None:
"""
``DISPlay:ANNotation:RECTangle<*>:REMove`` \n
Snippet: ``driver.display.annotation.rectangle.remove.set(annotation = repcap.Annotation.Default)`` \n
Removes the specified rectangle annotation from the screen.
:param annotation: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Annotation')
"""
annotation_cmd_val = self._cmd_group.get_repcap_cmd_value(annotation, repcap.Annotation)
self._core.io.write(f'DISPlay:ANNotation:RECTangle{annotation_cmd_val}:REMove')
[docs]
def set_and_wait(self, annotation=repcap.Annotation.Default, opc_timeout_ms: int = -1) -> None:
annotation_cmd_val = self._cmd_group.get_repcap_cmd_value(annotation, repcap.Annotation)
"""
``DISPlay:ANNotation:RECTangle<*>:REMove`` \n
Snippet: ``driver.display.annotation.rectangle.remove.set_and_wait(annotation = repcap.Annotation.Default)`` \n
Removes the specified rectangle annotation from the screen.
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 annotation: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Annotation')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'DISPlay:ANNotation:RECTangle{annotation_cmd_val}:REMove', opc_timeout_ms)