Source code for RsSmw.Implementations.Source.Bb.Ofdm.Alloc.Zad.Snumber

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


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

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

[docs] def get(self, allocationNull=repcap.AllocationNull.Default) -> int: """ ``[SOURce<HW>]:BB:OFDM:ALLoc<CH0>:ZAD:SNUMber`` \n Snippet: ``value: int = driver.source.bb.ofdm.alloc.zad.snumber.get(allocationNull = repcap.AllocationNull.Default)`` \n Sets the sequence number within the Zadoff-Chu sequence. The maximum sequence number is the sequence length minus 1. :param allocationNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Alloc') :return: seq_number: integer Range: 1 to 13106 """ 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}:ZAD:SNUMber?') return Conversions.str_to_int(response)