from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class NoiseCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("noise", core, parent)
[docs]
def set(self, state: bool, wgenerator=repcap.Wgenerator.Default) -> None:
"""
``WGENerator<*>:MODulation:NOISe`` \n
Snippet: ``driver.wgenerator.modulation.noise.set(state = False, wgenerator = repcap.Wgenerator.Default)`` \n
Enables the adding of noise to the waveform.
:param state: OFF | ON
:param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator')
"""
param = Conversions.bool_to_str(state)
wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator)
self._core.io.write(f'WGENerator{wgenerator_cmd_val}:MODulation:NOISe {param}')
[docs]
def get(self, wgenerator=repcap.Wgenerator.Default) -> bool:
"""
``WGENerator<*>:MODulation:NOISe`` \n
Snippet: ``value: bool = driver.wgenerator.modulation.noise.get(wgenerator = repcap.Wgenerator.Default)`` \n
Enables the adding of noise to the waveform.
:param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator')
:return: state: OFF | ON
"""
wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator)
response = self._core.io.query_str(f'WGENerator{wgenerator_cmd_val}:MODulation:NOISe?')
return Conversions.str_to_bool(response)