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
[docs]
class StateCls:
"""State commands group definition. 2 total commands, 1 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
@property
def all(self):
"""all commands group. 0 Sub-classes, 1 commands."""
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.ResourceState = None, target_sync_state: enums.SyncState = None) -> enums.ResourceState:
"""SCPI: FETCh:BLUetooth:MEASurement<Instance>:MEValuation:STATe \n
Snippet: value: enums.ResourceState = driver.multiEval.state.fetch(timeout = 1.0, target_main_state = enums.ResourceState.ACTive, target_sync_state = enums.SyncState.ADJusted) \n
Queries the main measurement state. Use FETCh:...:STATe:ALL? to query the measurement state including the substates. Use
INITiate..., STOP..., ABORt... to change the measurement state. \n
:param timeout: No help available
:param target_main_state: No help available
:param target_sync_state: No help available
:return: meas_state: OFF | RUN | RDY OFF: Measurement switched off, no resources allocated, no results available (when entered after ABORt...) . RUN: Measurement running (after INITiate..., READ...) , synchronization pending or adjusted, resources active or queued RDY: Measurement has been terminated, valid results are available."""
param = ArgSingleList().compose_cmd_string(ArgSingle('timeout', timeout, DataType.Float, None, is_optional=True), ArgSingle('target_main_state', target_main_state, DataType.Enum, enums.ResourceState, is_optional=True), ArgSingle('target_sync_state', target_sync_state, DataType.Enum, enums.SyncState, is_optional=True))
response = self._core.io.query_str(f'FETCh:BLUetooth: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