Source code for RsSmw.Implementations.Source.Bb.Ofdm.Alloc.Modulation

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 ModulationCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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

	# noinspection PyTypeChecker
[docs] def get(self, allocationNull=repcap.AllocationNull.Default) -> enums.C5GbaseMod: """ ``[SOURce<HW>]:BB:OFDM:ALLoc<CH0>:MODulation`` \n Snippet: ``value: enums.C5GbaseMod = driver.source.bb.ofdm.alloc.modulation.get(allocationNull = repcap.AllocationNull.Default)`` \n Sets the modulation type of an allocation. :param allocationNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Alloc') :return: base_mod_type: BPSK | QPSK | QAM16 | QAM64 | QAM256 | SCMA | CIQ | ZADoffchu | CUSConst | QAM1024 | QAM2048 | QAM4096 BPSK | QPSK Binary/quaternary phase shift keying QAM16 | QAM64 | QAM256 Quadrature amplitude modulation 16/64/256 SCMA Sparse code multiple access CIQ Custom IQ data file, loaded with the method ``RsSmw.source.bb.ofdm.alloc.ciqFile.get()`` . ZADoffchu Zadoff-Chu sequence CUSConst Custom constellation """ allocationNull_cmd_val = self._cmd_group.get_repcap_cmd_value(allocationNull, repcap.AllocationNull) response = self._core.io.query_str(f'SOURce<HwInstance>:BB:OFDM:ALLoc{allocationNull_cmd_val}:MODulation?') return Conversions.str_to_scalar_enum(response, enums.C5GbaseMod)