Source code for RsSmw.Implementations.Source.Bb.Eutra.Uplink.Refsig.Drs

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class DrsCls:
	"""Drs commands group definition. 8 total commands, 0 Subgroups, 8 group commands"""

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

[docs]	def get_dseq_shift(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:DSEQshift \n
		Snippet: value: int = driver.source.bb.eutra.uplink.refsig.drs.get_dseq_shift() \n
		Sets the delta sequence shift for NPUSCH required for the calculation of the NDRS group hopping pattern. \n
			:return: delta_seq_shift: integer Range: 0 to 29
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:DSEQshift?')
		return Conversions.str_to_int(response)

[docs]	def set_dseq_shift(self, delta_seq_shift: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:DSEQshift \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_dseq_shift(delta_seq_shift = 1) \n
		Sets the delta sequence shift for NPUSCH required for the calculation of the NDRS group hopping pattern. \n
			:param delta_seq_shift: integer Range: 0 to 29
		"""
		param = Conversions.decimal_value_to_str(delta_seq_shift)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:DSEQshift {param}')

[docs]	def get_ghopping(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:GHOPping \n
		Snippet: value: bool = driver.source.bb.eutra.uplink.refsig.drs.get_ghopping() \n
		Enables NDRS group hopping. \n
			:return: group_hopping: 1| ON| 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:GHOPping?')
		return Conversions.str_to_bool(response)

[docs]	def set_ghopping(self, group_hopping: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:GHOPping \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_ghopping(group_hopping = False) \n
		Enables NDRS group hopping. \n
			:param group_hopping: 1| ON| 0| OFF
		"""
		param = Conversions.bool_to_str(group_hopping)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:GHOPping {param}')

[docs]	def get_stb_sequence(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:STBSequence \n
		Snippet: value: int = driver.source.bb.eutra.uplink.refsig.drs.get_stb_sequence() \n
		Sets the six tone base sequence. \n
			:return: six_tone_base_seq: integer Range: 0 to 14
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:STBSequence?')
		return Conversions.str_to_int(response)

[docs]	def set_stb_sequence(self, six_tone_base_seq: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:STBSequence \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_stb_sequence(six_tone_base_seq = 1) \n
		Sets the six tone base sequence. \n
			:param six_tone_base_seq: integer Range: 0 to 14
		"""
		param = Conversions.decimal_value_to_str(six_tone_base_seq)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:STBSequence {param}')

[docs]	def get_stc_shift(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:STCShift \n
		Snippet: value: int = driver.source.bb.eutra.uplink.refsig.drs.get_stc_shift() \n
		Sets the six tone cyclic shift. \n
			:return: six_tone_cyc_shift: integer Range: 0 to 3
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:STCShift?')
		return Conversions.str_to_int(response)

[docs]	def set_stc_shift(self, six_tone_cyc_shift: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:STCShift \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_stc_shift(six_tone_cyc_shift = 1) \n
		Sets the six tone cyclic shift. \n
			:param six_tone_cyc_shift: integer Range: 0 to 3
		"""
		param = Conversions.decimal_value_to_str(six_tone_cyc_shift)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:STCShift {param}')

[docs]	def get_ttb_sequence(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:TTBSequence \n
		Snippet: value: int = driver.source.bb.eutra.uplink.refsig.drs.get_ttb_sequence() \n
		Sets the three tone base sequence. \n
			:return: three_tone_base_sq: integer Range: 0 to 12
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:TTBSequence?')
		return Conversions.str_to_int(response)

[docs]	def set_ttb_sequence(self, three_tone_base_sq: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:TTBSequence \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_ttb_sequence(three_tone_base_sq = 1) \n
		Sets the three tone base sequence. \n
			:param three_tone_base_sq: integer Range: 0 to 12
		"""
		param = Conversions.decimal_value_to_str(three_tone_base_sq)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:TTBSequence {param}')

[docs]	def get_ttc_shift(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:TTCShift \n
		Snippet: value: int = driver.source.bb.eutra.uplink.refsig.drs.get_ttc_shift() \n
		Sets the three tone cyclic shift. \n
			:return: three_tone_cyc_shi: integer Range: 0 to 2
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:TTCShift?')
		return Conversions.str_to_int(response)

[docs]	def set_ttc_shift(self, three_tone_cyc_shi: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:TTCShift \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_ttc_shift(three_tone_cyc_shi = 1) \n
		Sets the three tone cyclic shift. \n
			:param three_tone_cyc_shi: integer Range: 0 to 2
		"""
		param = Conversions.decimal_value_to_str(three_tone_cyc_shi)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:TTCShift {param}')

[docs]	def get_twb_sequence(self) -> int:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:TWBSequence \n
		Snippet: value: int = driver.source.bb.eutra.uplink.refsig.drs.get_twb_sequence() \n
		Sets the 12 tone base sequence. \n
			:return: twelfe_tone_base_s: integer Range: 0 to 30
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:TWBSequence?')
		return Conversions.str_to_int(response)

[docs]	def set_twb_sequence(self, twelfe_tone_base_s: int) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:TWBSequence \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_twb_sequence(twelfe_tone_base_s = 1) \n
		Sets the 12 tone base sequence. \n
			:param twelfe_tone_base_s: integer Range: 0 to 30
		"""
		param = Conversions.decimal_value_to_str(twelfe_tone_base_s)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:TWBSequence {param}')

[docs]	def get_use_base(self) -> bool:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:USEBase \n
		Snippet: value: bool = driver.source.bb.eutra.uplink.refsig.drs.get_use_base() \n
		Enables using base sequences for the generation of the NB-IoT DMRS sequence hopping pattern. \n
			:return: use_base_sequence: 1| ON| 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:USEBase?')
		return Conversions.str_to_bool(response)

[docs]	def set_use_base(self, use_base_sequence: bool) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:REFSig:DRS:USEBase \n
		Snippet: driver.source.bb.eutra.uplink.refsig.drs.set_use_base(use_base_sequence = False) \n
		Enables using base sequences for the generation of the NB-IoT DMRS sequence hopping pattern. \n
			:param use_base_sequence: 1| ON| 0| OFF
		"""
		param = Conversions.bool_to_str(use_base_sequence)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:REFSig:DRS:USEBase {param}')