from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs]
def set(self, state: bool, generatorIx=repcap.GeneratorIx.Default) -> None:
"""
``[SOURce<HW>]:AM<CH>:STATe`` \n
Snippet: ``driver.source.am.state.set(state = False, generatorIx = repcap.GeneratorIx.Default)`` \n
Activates amplitude modulation.
:param state: 1 | ON | 0| OFF
:param generatorIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Am')
"""
param = Conversions.bool_to_str(state)
generatorIx_cmd_val = self._cmd_group.get_repcap_cmd_value(generatorIx, repcap.GeneratorIx)
self._core.io.write(f'SOURce<HwInstance>:AM{generatorIx_cmd_val}:STATe {param}')
[docs]
def get(self, generatorIx=repcap.GeneratorIx.Default) -> bool:
"""
``[SOURce<HW>]:AM<CH>:STATe`` \n
Snippet: ``value: bool = driver.source.am.state.get(generatorIx = repcap.GeneratorIx.Default)`` \n
Activates amplitude modulation.
:param generatorIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Am')
:return: state: 1 | ON | 0| OFF
"""
generatorIx_cmd_val = self._cmd_group.get_repcap_cmd_value(generatorIx, repcap.GeneratorIx)
response = self._core.io.query_str(f'SOURce<HwInstance>:AM{generatorIx_cmd_val}:STATe?')
return Conversions.str_to_bool(response)