Source code for rsmxo.Implementations.Wgenerator.Modulation.Fm.Symmetry

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SymmetryCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("symmetry", core, parent)

[docs] def set(self, ramp_symmetry: float, waveformGen=repcap.WaveformGen.Default) -> None: """ ``WGENerator<*>:MODulation:FM:SYMMetry`` \n Snippet: ``driver.wgenerator.modulation.fm.symmetry.set(ramp_symmetry = 1.0, waveformGen = repcap.WaveformGen.Default)`` \n Sets the symmetry for the FM ramp modulation waveform, the percentage of time that the waveform is rising. :param ramp_symmetry: 0 to 100 :param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') """ param = Conversions.decimal_value_to_str(ramp_symmetry) waveformGen_cmd_val = self._cmd_group.get_repcap_cmd_value(waveformGen, repcap.WaveformGen) self._core.io.write(f'WGENerator{waveformGen_cmd_val}:MODulation:FM:SYMMetry {param}')
[docs] def get(self, waveformGen=repcap.WaveformGen.Default) -> float: """ ``WGENerator<*>:MODulation:FM:SYMMetry`` \n Snippet: ``value: float = driver.wgenerator.modulation.fm.symmetry.get(waveformGen = repcap.WaveformGen.Default)`` \n Sets the symmetry for the FM ramp modulation waveform, the percentage of time that the waveform is rising. :param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') :return: ramp_symmetry: 0 to 100 """ 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:FM:SYMMetry?') return Conversions.str_to_float(response)