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, 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
[docs]
def set(self, control: bool) -> None:
"""SCPI: SOURce:GPRF:GENerator<Instance>:STATe \n
Snippet: driver.source.gprf.generator.state.set(control = False) \n
Turns the generator on or off. \n
:param control: Switch the generator ON or OFF.
"""
param = Conversions.bool_to_str(control)
self._core.io.write_with_opc(f'SOURce:GPRF:GENerator<Instance>:STATe {param}')
# noinspection PyTypeChecker
[docs]
def get(self) -> enums.GeneratorState:
"""SCPI: SOURce:GPRF:GENerator<Instance>:STATe \n
Snippet: value: enums.GeneratorState = driver.source.gprf.generator.state.get() \n
Turns the generator on or off. \n
:return: generator_state: OFF: Generator switched off. PEND: State transition ongoing. ON: Generator switched on, signal available."""
response = self._core.io.query_str_with_opc(f'SOURce:GPRF:GENerator<Instance>:STATe?')
return Conversions.str_to_scalar_enum(response, enums.GeneratorState)
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