Source code for RsSmw.Implementations.Source.Bb.W3Gpp.Mstation.Prach.Sformat

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


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

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



[docs]
	def set(self, sformat: int, mobileStation=repcap.MobileStation.Default) -> None:
		"""
		``[SOURce<HW>]:BB:W3GPp:MSTation<ST>:PRACh:SFORmat`` \n
		Snippet: ``driver.source.bb.w3Gpp.mstation.prach.sformat.set(sformat = 1, mobileStation = repcap.MobileStation.Default)`` \n
		Defines the slot format of the PRACH. A change of slot format leads to an automatic change of symbol rate method
		``RsSmw.source.bb.w3Gpp.mstation.prach.symbolRate.set()`` When channel coding is active, the slot format is predetermined.
		So in this case, the command has no effect.

		:param sformat: 0 | 1 | 2 | 3
		:param mobileStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mstation')
		"""
		param = Conversions.decimal_value_to_str(sformat)
		mobileStation_cmd_val = self._cmd_group.get_repcap_cmd_value(mobileStation, repcap.MobileStation)
		self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:MSTation{mobileStation_cmd_val}:PRACh:SFORmat {param}')





[docs]
	def get(self, mobileStation=repcap.MobileStation.Default) -> int:
		"""
		``[SOURce<HW>]:BB:W3GPp:MSTation<ST>:PRACh:SFORmat`` \n
		Snippet: ``value: int = driver.source.bb.w3Gpp.mstation.prach.sformat.get(mobileStation = repcap.MobileStation.Default)`` \n
		Defines the slot format of the PRACH. A change of slot format leads to an automatic change of symbol rate method
		``RsSmw.source.bb.w3Gpp.mstation.prach.symbolRate.set()`` When channel coding is active, the slot format is predetermined.
		So in this case, the command has no effect.

		:param mobileStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Mstation')
		:return: sformat: 0 | 1 | 2 | 3
		"""
		mobileStation_cmd_val = self._cmd_group.get_repcap_cmd_value(mobileStation, repcap.MobileStation)
		response = self._core.io.query_str(f'SOURce<HwInstance>:BB:W3GPp:MSTation{mobileStation_cmd_val}:PRACh:SFORmat?')
		return Conversions.str_to_int(response)