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.BusTbtoResultState:
"""
``SEARch:RESult:TBTO:FRAMe<*>:STATe`` \n
Snippet: ``value: enums.BusTbtoResultState = driver.search.result.tbto.frame.state.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the state of the frame within the search result.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:return: state: OK | ERRFEC | ERRZERO | ERROOR | ERRCRC | INComplete \n
- OK: Valid frame.
- ERRFEC: Reed-Solomon forward error correction.
- ERRZERO: Zero ternary symbol pair error.
- ERROOR: Values are out of range error.
- ERR_CRC: Erroneous frame due to CRC error.
- INComplete: Incomplete frame.
"""
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:TBTO:FRAMe{busFrameNull_cmd_val}:STATe? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusTbtoResultState)