Source code for rsmxo.Implementations.Wgenerator.Modulation.State

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, modulation: bool, waveformGen=repcap.WaveformGen.Default) -> None: """ ``WGENerator<*>:MODulation[:STATe]`` \n Snippet: ``driver.wgenerator.modulation.state.set(modulation = False, waveformGen = repcap.WaveformGen.Default)`` \n Enables or disables modulation. :param modulation: OFF | ON :param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') """ param = Conversions.bool_to_str(modulation) waveformGen_cmd_val = self._cmd_group.get_repcap_cmd_value(waveformGen, repcap.WaveformGen) self._core.io.write(f'WGENerator{waveformGen_cmd_val}:MODulation:STATe {param}')
[docs] def get(self, waveformGen=repcap.WaveformGen.Default) -> bool: """ ``WGENerator<*>:MODulation[:STATe]`` \n Snippet: ``value: bool = driver.wgenerator.modulation.state.get(waveformGen = repcap.WaveformGen.Default)`` \n Enables or disables modulation. :param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') :return: modulation: OFF | ON """ waveformGen_cmd_val = self._cmd_group.get_repcap_cmd_value(waveformGen, repcap.WaveformGen) response = self._core.io.query_str(f'WGENerator{waveformGen_cmd_val}:MODulation:STATe?') return Conversions.str_to_bool(response)