Source code for RsSmbv.Implementations.Source.Bb.Eutra.Uplink.Ue.Mode

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection

[docs]class ModeCls:
	"""Mode commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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


[docs]	def set(self, mode: enums.EutraUeMode, userEquipment=repcap.UserEquipment.Default) -> None:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:UE<ST>:MODE \n
		Snippet: driver.source.bb.eutra.uplink.ue.mode.set(mode = enums.EutraUeMode.PRACh, userEquipment = repcap.UserEquipment.Default) \n
		Selects whether the user equipment is in standard or in PRACH mode. \n
			:param mode: STD| PRACh
			:param userEquipment: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Ue')
		"""
		param = Conversions.enum_scalar_to_str(mode, enums.EutraUeMode)
		userEquipment_cmd_val = self._cmd_group.get_repcap_cmd_value(userEquipment, repcap.UserEquipment)
		self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:UL:UE{userEquipment_cmd_val}:MODE {param}')


	# noinspection PyTypeChecker

[docs]	def get(self, userEquipment=repcap.UserEquipment.Default) -> enums.EutraUeMode:
		"""SCPI: [SOURce<HW>]:BB:EUTRa:UL:UE<ST>:MODE \n
		Snippet: value: enums.EutraUeMode = driver.source.bb.eutra.uplink.ue.mode.get(userEquipment = repcap.UserEquipment.Default) \n
		Selects whether the user equipment is in standard or in PRACH mode. \n
			:param userEquipment: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Ue')
			:return: mode: STD| PRACh"""
		userEquipment_cmd_val = self._cmd_group.get_repcap_cmd_value(userEquipment, repcap.UserEquipment)
		response = self._core.io.query_str(f'SOURce<HwInstance>:BB:EUTRa:UL:UE{userEquipment_cmd_val}:MODE?')
		return Conversions.str_to_scalar_enum(response, enums.EutraUeMode)