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, histogram=repcap.Histogram.Default) -> None:
"""
``HISTogram<*>:REMove`` \n
Snippet: ``driver.histogram.remove.set(histogram = repcap.Histogram.Default)`` \n
Deletes the specified histogram.
:param histogram: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Histogram')
"""
histogram_cmd_val = self._cmd_group.get_repcap_cmd_value(histogram, repcap.Histogram)
self._core.io.write(f'HISTogram{histogram_cmd_val}:REMove')
[docs]
def set_and_wait(self, histogram=repcap.Histogram.Default, opc_timeout_ms: int = -1) -> None:
histogram_cmd_val = self._cmd_group.get_repcap_cmd_value(histogram, repcap.Histogram)
"""
``HISTogram<*>:REMove`` \n
Snippet: ``driver.histogram.remove.set_and_wait(histogram = repcap.Histogram.Default)`` \n
Deletes the specified histogram.
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 histogram: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Histogram')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'HISTogram{histogram_cmd_val}:REMove', opc_timeout_ms)