from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Types import DataType
from .....Internal.ArgSingleList import ArgSingleList
from .....Internal.ArgSingle import ArgSingle
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 2
| Subgroups: 1
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
@property
def all(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_all'):
from .All import AllCls
self._all = AllCls(self._core, self._cmd_group)
return self._all
# noinspection PyTypeChecker
[docs]
def fetch(self, timeout: float=None, target_main_state: enums.TargetStateA=None, target_sync_state: enums.TargetSyncState=None) -> enums.ResourceState:
"""
``FETCh:NRSub:MEASurement<Instance>:MEValuation:STATe`` \n
Snippet: ``value: enums.ResourceState = driver.nrSubMeas.multiEval.state.fetch(timeout = 1.0, target_main_state = enums.TargetStateA.OFF, target_sync_state = enums.TargetSyncState.ADJusted)`` \n
Queries the main measurement state. Without query parameters, the state is returned immediately. With query parameters,
the state is returned when the <TargetMainState> and the <TargetSyncState> are reached or when the <Timeout> expires.
:param timeout: numeric
:param target_main_state: Target MainState for the query Default is RUN.
:param target_sync_state: Target SyncState for the query Default is ADJ.
:return: meas_status: Current state or target state of ongoing state transition OFF: measurement off RUN: measurement running RDY: measurement completed
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('timeout', timeout, DataType.Float, None, is_optional=True), ArgSingle('target_main_state', target_main_state, DataType.Enum, enums.TargetStateA, is_optional=True), ArgSingle('target_sync_state', target_sync_state, DataType.Enum, enums.TargetSyncState, is_optional=True))
response = self._core.io.query_str(f'FETCh:NRSub:MEASurement<Instance>:MEValuation:STATe? {param}'.rstrip())
return Conversions.str_to_scalar_enum(response, enums.ResourceState)
def clone(self) -> 'StateCls':
"""
Clones the group by creating new object from it and its whole existing subgroups.
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group.
"""
new_group = StateCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group