Source code for RsSmw.Implementations.Source.Bb.Eutra.Downlink.Emtc.Bmp

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class BmpCls:
	"""
	| Commands in total: 7
	| Subgroups: 3
	| Direct child commands: 4
	"""

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

	@property
	def deselectAll(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_deselectAll'):
			from .DeselectAll import DeselectAllCls
			self._deselectAll = DeselectAllCls(self._core, self._cmd_group)
		return self._deselectAll

	@property
	def selectAll(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_selectAll'):
			from .SelectAll import SelectAllCls
			self._selectAll = SelectAllCls(self._core, self._cmd_group)
		return self._selectAll

	@property
	def valSubFrames(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_valSubFrames'):
			from .ValSubFrames import ValSubFramesCls
			self._valSubFrames = ValSubFramesCls(self._core, self._cmd_group)
		return self._valSubFrames


[docs]
	def get_pbchrep(self) -> bool:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:PBCHrep`` \n
		Snippet: ``value: bool = driver.source.bb.eutra.downlink.emtc.bmp.get_pbchrep()`` \n
		Configures the cell for PBCH repetition.

		:return: pbch_repetitions: 1 | ON | 0| OFF
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:PBCHrep?')
		return Conversions.str_to_bool(response)



[docs]
	def set_pbchrep(self, pbch_repetitions: bool) -> None:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:PBCHrep`` \n
		Snippet: ``driver.source.bb.eutra.downlink.emtc.bmp.set_pbchrep(pbch_repetitions = False)`` \n
		Configures the cell for PBCH repetition.

		:param pbch_repetitions: 1 | ON | 0| OFF
		"""
		param = Conversions.bool_to_str(pbch_repetitions)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:PBCHrep {param}')



[docs]
	def get_sibbr(self) -> int:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:SIBBr`` \n
		Snippet: ``value: int = driver.source.bb.eutra.downlink.emtc.bmp.get_sibbr()`` \n
		Sets the number of times the PDSCH allocation carrying the SIB1-BR is repeated.

		:return: sched_info_sib_1_br: integer Range: 0 to 18
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:SIBBr?')
		return Conversions.str_to_int(response)



[docs]
	def set_sibbr(self, sched_info_sib_1_br: int) -> None:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:SIBBr`` \n
		Snippet: ``driver.source.bb.eutra.downlink.emtc.bmp.set_sibbr(sched_info_sib_1_br = 1)`` \n
		Sets the number of times the PDSCH allocation carrying the SIB1-BR is repeated.

		:param sched_info_sib_1_br: integer Range: 0 to 18
		"""
		param = Conversions.decimal_value_to_str(sched_info_sib_1_br)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:SIBBr {param}')


	# noinspection PyTypeChecker

[docs]
	def get_start(self) -> enums.NumberA:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:STARt`` \n
		Snippet: ``value: enums.NumberA = driver.source.bb.eutra.downlink.emtc.bmp.get_start()`` \n
		Defines the first symbol within a frame that can be used for eMTC.

		:return: starting_symbol: 1 | 2| 3 | 4
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:STARt?')
		return Conversions.str_to_scalar_enum(response, enums.NumberA)



[docs]
	def set_start(self, starting_symbol: enums.NumberA) -> None:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:STARt`` \n
		Snippet: ``driver.source.bb.eutra.downlink.emtc.bmp.set_start(starting_symbol = enums.NumberA._1)`` \n
		Defines the first symbol within a frame that can be used for eMTC.

		:param starting_symbol: 1 | 2| 3 | 4
		"""
		param = Conversions.enum_scalar_to_str(starting_symbol, enums.NumberA)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:STARt {param}')


	# noinspection PyTypeChecker

[docs]
	def get_sub_frames(self) -> enums.EutraBitmap:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:SUBFrames`` \n
		Snippet: ``value: enums.EutraBitmap = driver.source.bb.eutra.downlink.emtc.bmp.get_sub_frames()`` \n
		Sets the valid subframes configuration over 10ms or 40ms.

		:return: bitmap_subframes: 10 | 40
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:SUBFrames?')
		return Conversions.str_to_scalar_enum(response, enums.EutraBitmap)



[docs]
	def set_sub_frames(self, bitmap_subframes: enums.EutraBitmap) -> None:
		"""
		``[SOURce<HW>]:BB:EUTRa:DL:EMTC:BMP:SUBFrames`` \n
		Snippet: ``driver.source.bb.eutra.downlink.emtc.bmp.set_sub_frames(bitmap_subframes = enums.EutraBitmap._10)`` \n
		Sets the valid subframes configuration over 10ms or 40ms.

		:param bitmap_subframes: 10 | 40
		"""
		param = Conversions.enum_scalar_to_str(bitmap_subframes, enums.EutraBitmap)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:EMTC:BMP:SUBFrames {param}')


	def clone(self) -> 'BmpCls':
		"""
		Clones the group by creating new object from it and its whole existing subgroups.
		Also copies all the existing default Repeated Capabilities setting,
		which you can change independently without affecting the original group.
		"""
		new_group = BmpCls(self._core, self._cmd_group.parent)
		self._cmd_group.synchronize_repcaps(new_group)
		return new_group