Source code for rsrtx.Implementations.Bus.Mphy.Result.Frame.Cell.State

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


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

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

	# noinspection PyTypeChecker
[docs] def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> enums.BusMphyResultState: """ ``BUS<*>:MPHY:RESult:FRAMe<*>:CELL<*>:STATe`` \n Snippet: ``value: enums.BusMphyResultState = driver.bus.mphy.result.frame.cell.state.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n Returns the state for the selected cell. :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') :param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame') :param busCellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell') :return: state: OK | RSVDERROR | CMDERROR | SYMBOLERROR | UNKNOWNERROR | INVALID | INCOMPLETE | UNCorrelated | CRCERROR | VOOR | LENGTHERROR """ bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus) busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull) busCellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busCellNull, repcap.BusCellNull) response = self._core.io.query_str(f'BUS{bus_cmd_val}:MPHY:RESult:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:STATe?') return Conversions.str_to_scalar_enum(response, enums.BusMphyResultState)