from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class UpdateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("update", core, parent)
[docs]
def set(self, maskTest=repcap.MaskTest.Default) -> None:
"""
``MTESt<*>:AUTomask:UPDate`` \n
Snippet: ``driver.mtest.automask.update.set(maskTest = repcap.MaskTest.Default)`` \n
Creates or updates the upper and lower mask limit from the envelope of the selected source by copying the waveform data.
See also: method ``RsMxo.mtest.source.set()`` .
:param maskTest: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mtest')
"""
maskTest_cmd_val = self._cmd_group.get_repcap_cmd_value(maskTest, repcap.MaskTest)
self._core.io.write(f'MTESt{maskTest_cmd_val}:AUTomask:UPDate')
[docs]
def set_and_wait(self, maskTest=repcap.MaskTest.Default, opc_timeout_ms: int = -1) -> None:
maskTest_cmd_val = self._cmd_group.get_repcap_cmd_value(maskTest, repcap.MaskTest)
"""
``MTESt<*>:AUTomask:UPDate`` \n
Snippet: ``driver.mtest.automask.update.set_and_wait(maskTest = repcap.MaskTest.Default)`` \n
Creates or updates the upper and lower mask limit from the envelope of the selected source by copying the waveform data.
See also: method ``RsMxo.mtest.source.set()`` .
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 maskTest: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mtest')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'MTESt{maskTest_cmd_val}:AUTomask:UPDate', opc_timeout_ms)
[docs]
def get(self, maskTest=repcap.MaskTest.Default) -> bool:
"""
``MTESt<*>:AUTomask:UPDate`` \n
Snippet: ``value: bool = driver.mtest.automask.update.get(maskTest = repcap.MaskTest.Default)`` \n
Creates or updates the upper and lower mask limit from the envelope of the selected source by copying the waveform data.
See also: method ``RsMxo.mtest.source.set()`` .
:param maskTest: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mtest')
"""
maskTest_cmd_val = self._cmd_group.get_repcap_cmd_value(maskTest, repcap.MaskTest)
response = self._core.io.query_str(f'MTESt{maskTest_cmd_val}:AUTomask:UPDate?')
return Conversions.str_to_bool(response)