from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FunctionCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("function", core, parent)
[docs]
def set(self, signal_type: enums.WgenSignalType, waveformGen=repcap.WaveformGen.Default) -> None:
"""
``WGENerator<*>:MODulation:AM[:FUNCtion]`` \n
Snippet: ``driver.wgenerator.modulation.am.function.set(signal_type = enums.WgenSignalType.RAMP, waveformGen = repcap.WaveformGen.Default)`` \n
Selects the type of the modulating signal for AM modulation.
:param signal_type: SINusoid | SQUare | RAMP
:param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator')
"""
param = Conversions.enum_scalar_to_str(signal_type, enums.WgenSignalType)
waveformGen_cmd_val = self._cmd_group.get_repcap_cmd_value(waveformGen, repcap.WaveformGen)
self._core.io.write(f'WGENerator{waveformGen_cmd_val}:MODulation:AM:FUNCtion {param}')
# noinspection PyTypeChecker
[docs]
def get(self, waveformGen=repcap.WaveformGen.Default) -> enums.WgenSignalType:
"""
``WGENerator<*>:MODulation:AM[:FUNCtion]`` \n
Snippet: ``value: enums.WgenSignalType = driver.wgenerator.modulation.am.function.get(waveformGen = repcap.WaveformGen.Default)`` \n
Selects the type of the modulating signal for AM modulation.
:param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator')
:return: signal_type: SINusoid | SQUare | RAMP
"""
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:AM:FUNCtion?')
return Conversions.str_to_scalar_enum(response, enums.WgenSignalType)