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)
# noinspection PyTypeChecker
[docs]
def get_pon(self) -> enums.PowOutpPonMode:
"""SCPI: OUTPut<HW>:[STATe]:PON \n
Snippet: value: enums.PowOutpPonMode = driver.output.state.get_pon() \n
Selects the state of the RF output when the instrument is switched on. \n
:return: pon: OFF| UNCHanged OFF Deactivates the output when the instrument is switched on ([RF off]) . UNCHanged Restores the initial state of the RF output before the last turn off.
"""
response = self._core.io.query_str('OUTPut<HwInstance>:STATe:PON?')
return Conversions.str_to_scalar_enum(response, enums.PowOutpPonMode)
[docs]
def set_pon(self, pon: enums.PowOutpPonMode) -> None:
"""SCPI: OUTPut<HW>:[STATe]:PON \n
Snippet: driver.output.state.set_pon(pon = enums.PowOutpPonMode.OFF) \n
Selects the state of the RF output when the instrument is switched on. \n
:param pon: OFF| UNCHanged OFF Deactivates the output when the instrument is switched on ([RF off]) . UNCHanged Restores the initial state of the RF output before the last turn off.
"""
param = Conversions.enum_scalar_to_str(pon, enums.PowOutpPonMode)
self._core.io.write(f'OUTPut<HwInstance>:STATe:PON {param}')
[docs]
def get_value(self) -> bool:
"""SCPI: OUTPut<HW>:[STATe] \n
Snippet: value: bool = driver.output.state.get_value() \n
Activates the RF output signal ([RF on/off]) . \n
:return: state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('OUTPut<HwInstance>:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_value(self, state: bool) -> None:
"""SCPI: OUTPut<HW>:[STATe] \n
Snippet: driver.output.state.set_value(state = False) \n
Activates the RF output signal ([RF on/off]) . \n
:param state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'OUTPut<HwInstance>:STATe {param}')