from typing import List
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 AllCls:
"""All commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("all", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, timeout: float = None, target_main_state: enums.TargetMainState = None, target_sync_state: enums.TargetSyncState = None) -> List[enums.GeneratorState]:
"""SCPI: SOURce:GPRF:GENerator<Instance>:SEQuencer:STATe:ALL \n
Snippet: value: List[enums.GeneratorState] = driver.source.sequencer.state.all.get(timeout = 1.0, target_main_state = enums.TargetMainState.OFF, target_sync_state = enums.TargetSyncState.ADJusted) \n
Queries the states of the generator. Without query parameters, the states are returned immediately. With query parameters,
the states are returned when the <TargetMainState> and the <TargetSyncState> are reached or when the <Timeout> expires. \n
:param timeout: numeric Unit: ms
:param target_main_state: OFF | RUN | STOP Target MainState for the query OFF: main state OFF RUN: main state ON STOP: main state RDY Default is RUN.
:param target_sync_state: PENDing | ADJusted Target SyncState for the query Default is ADJ.
:return: all_states: No help 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.TargetMainState, is_optional=True), ArgSingle('target_sync_state', target_sync_state, DataType.Enum, enums.TargetSyncState, is_optional=True))
response = self._core.io.query_str(f'SOURce:GPRF:GENerator<Instance>:SEQuencer:STATe:ALL? {param}'.rstrip())
return Conversions.str_to_list_enum(response, enums.GeneratorState)