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, search: str, busFrameNull=repcap.BusFrameNull.Default) -> enums.BusMphyResultState:
"""
``SEARch:RESult:MPHY:FRAMe<*>:STATe`` \n
Snippet: ``value: enums.BusMphyResultState = driver.search.result.mphy.frame.state.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the state of the selected frame within the search result.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:return: state: OK | RSVDERROR | CMDERROR | SYMBOLERROR | UNKNOWNERROR | INVALID | INCOMPLETE | UNCorrelated | CRCERROR | VOOR | LENGTHERROR \n
- OK: Valid frame.
- RSVDERROR: Erroneous frame due to reserved bit error.
- CMDERROR: Erroneous frame due to LCC error.
- LENGTHERROR: Erroneous frame due to length error.
- SYMBOLERROR: Erroneous frame due to 8b10b symbol error.
- UNKNOWNERROR: Erroneous frame due to unidentified UniPro frame error.
- INVALID: Invalid frame.
- INCOMPLETE: The frame is not complete.
"""
param = Conversions.value_to_quoted_str(search)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
response = self._core.io.query_str(f'SEARch:RESult:MPHY:FRAMe{busFrameNull_cmd_val}:STATe? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusMphyResultState)