from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs]
def set(self, state: bool) -> None:
"""
``[SENSe]:SWEep:SCAPture:STATe`` \n
Snippet: ``driver.applications.k14Xnr5G.sense.sweep.scapture.state.set(state = False)`` \n
If activated, data is captured for the specified duration before and after each trigger event, for the specified number
of trigger events. The signal data between these capture times is not stored in the capture buffer.
:param state: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SENSe:SWEep:SCAPture:STATe {param}')
[docs]
def get(self) -> bool:
"""
``[SENSe]:SWEep:SCAPture:STATe`` \n
Snippet: ``value: bool = driver.applications.k14Xnr5G.sense.sweep.scapture.state.get()`` \n
If activated, data is captured for the specified duration before and after each trigger event, for the specified number
of trigger events. The signal data between these capture times is not stored in the capture buffer.
:return: state: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
"""
response = self._core.io.query_str(f'SENSe:SWEep:SCAPture:STATe?')
return Conversions.str_to_bool(response)