from typing import List
from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class StateCls:
"""State commands group definition. 2 total commands, 0 Subgroups, 2 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs] def set(self, gen_control: bool) -> None:
"""SCPI: SOURce:AFRF:GENerator<Instance>:STATe \n
Snippet: driver.source.afRf.generator.state.set(gen_control = False) \n
Starts or stops the AFRF generator. \n
:param gen_control: ON | OFF ON Starts the generator OFF Stops the generator
"""
param = Conversions.bool_to_str(gen_control)
self._core.io.write_with_opc(f'SOURce:AFRF:GENerator<Instance>:STATe {param}')
# noinspection PyTypeChecker
[docs] def get(self) -> enums.GeneratorState:
"""SCPI: SOURce:AFRF:GENerator<Instance>:STATe \n
Snippet: value: enums.GeneratorState = driver.source.afRf.generator.state.get() \n
Starts or stops the AFRF generator. \n
:return: gen_state: OFF | ON | PENDing OFF Generator is off ON Generator is running PENDing Start or stop of generator is ongoing"""
response = self._core.io.query_str_with_opc(f'SOURce:AFRF:GENerator<Instance>:STATe?')
return Conversions.str_to_scalar_enum(response, enums.GeneratorState)
# noinspection PyTypeChecker
[docs] def get_all(self) -> List[enums.GeneratorState]:
"""SCPI: SOURce:AFRF:GENerator<Instance>:STATe:ALL \n
Snippet: value: List[enums.GeneratorState] = driver.source.afRf.generator.state.get_all() \n
No command help available \n
:return: all_states: No help available
"""
response = self._core.io.query_str('SOURce:AFRF:GENerator<Instance>:STATe:ALL?')
return Conversions.str_to_list_enum(response, enums.GeneratorState)