from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class HoldCls:
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("hold", core, parent)
[docs]
def reset(self) -> None:
"""
``[SOURce<HW>]:BBIN:OLOad:HOLD:RESet`` \n
Snippet: ``driver.source.bbin.oload.hold.reset()`` \n
Reset of the Overload Hold indication.
"""
self._core.io.write(f'SOURce<HwInstance>:BBIN:OLOad:HOLD:RESet')
[docs]
def reset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``[SOURce<HW>]:BBIN:OLOad:HOLD:RESet`` \n
Snippet: ``driver.source.bbin.oload.hold.reset_with_opc()`` \n
Reset of the Overload Hold indication.
Same as reset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'SOURce<HwInstance>:BBIN:OLOad:HOLD:RESet', opc_timeout_ms)
[docs]
def get_state(self) -> bool:
"""
``[SOURce<HW>]:BBIN:OLOad:HOLD:STATe`` \n
Snippet: ``value: bool = driver.source.bbin.oload.hold.get_state()`` \n
Queries an overload since the last reset for evaluating the measurement.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BBIN:OLOad:HOLD:STATe?')
return Conversions.str_to_bool(response)