from typing import List
from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.Types import DataType
from ....Internal.ArgSingleList import ArgSingleList
from ....Internal.ArgSingle import ArgSingle
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class ModulationCls:
"""Modulation commands group definition. 2 total commands, 0 Subgroups, 2 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("modulation", core, parent)
[docs]
def set(self, index: int, modulation: bool) -> None:
"""SCPI: SOURce:GPRF:GENerator<Instance>:LIST:MODulation \n
Snippet: driver.source.listPy.modulation.set(index = 1, modulation = False) \n
Defines or queries the 'Mod. On / Off' setting of a selected frequency/level step. The setting is valid only in arbitrary
baseband mode (see method RsCmwGprfGen.Source.bbMode) . \n
:param index: integer Number of the frequency/level step in the table Range: 0 to 1999
:param modulation: OFF | ON Switch modulation OFF or ON
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('index', index, DataType.Integer), ArgSingle('modulation', modulation, DataType.Boolean))
self._core.io.write(f'SOURce:GPRF:GENerator<Instance>:LIST:MODulation {param}'.rstrip())
[docs]
def get(self, index: int) -> bool:
"""SCPI: SOURce:GPRF:GENerator<Instance>:LIST:MODulation \n
Snippet: value: bool = driver.source.listPy.modulation.get(index = 1) \n
Defines or queries the 'Mod. On / Off' setting of a selected frequency/level step. The setting is valid only in arbitrary
baseband mode (see method RsCmwGprfGen.Source.bbMode) . \n
:param index: integer Number of the frequency/level step in the table Range: 0 to 1999
:return: modulation: OFF | ON Switch modulation OFF or ON"""
param = Conversions.decimal_value_to_str(index)
response = self._core.io.query_str(f'SOURce:GPRF:GENerator<Instance>:LIST:MODulation? {param}')
return Conversions.str_to_bool(response)
[docs]
def get_all(self) -> List[bool]:
"""SCPI: SOURce:GPRF:GENerator<Instance>:LIST:MODulation:ALL \n
Snippet: value: List[bool] = driver.source.listPy.modulation.get_all() \n
Defines or queries the 'Mod. On / Off' setting of all frequency/level steps. The setting is valid only in arbitrary
baseband mode (see method RsCmwGprfGen.Source.bbMode) . \n
:return: all_modulations: OFF | ON Comma-separated list of n values, one per frequency/level step, where n 2001. The query returns 2000 results. Each value switches the modulation of a step OFF or ON.
"""
response = self._core.io.query_str('SOURce:GPRF:GENerator<Instance>:LIST:MODulation:ALL?')
return Conversions.str_to_bool_list(response)
[docs]
def set_all(self, all_modulations: List[bool]) -> None:
"""SCPI: SOURce:GPRF:GENerator<Instance>:LIST:MODulation:ALL \n
Snippet: driver.source.listPy.modulation.set_all(all_modulations = [True, False, True]) \n
Defines or queries the 'Mod. On / Off' setting of all frequency/level steps. The setting is valid only in arbitrary
baseband mode (see method RsCmwGprfGen.Source.bbMode) . \n
:param all_modulations: OFF | ON Comma-separated list of n values, one per frequency/level step, where n 2001. The query returns 2000 results. Each value switches the modulation of a step OFF or ON.
"""
param = Conversions.list_to_csv_str(all_modulations)
self._core.io.write(f'SOURce:GPRF:GENerator<Instance>:LIST:MODulation:ALL {param}')