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 StatusCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("status", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, search: str, ebtbSymbol=repcap.EbtbSymbol.Default) -> enums.BusEbtbSymbolState:
"""
``SEARch:RESult:EBTB:SYMBol<*>:STATus`` \n
Snippet: ``value: enums.BusEbtbSymbolState = driver.search.result.ebtb.symbol.status.get(search = 'abc', ebtbSymbol = repcap.EbtbSymbol.Default)`` \n
Returns the status of the specified symbol within the search result. It can show what kind of error was detected or no
error.
:param ebtbSymbol: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Symbol')
:return: state: OK | UNK | DISPARITY | DISParity | GLITCH | GLITch \n
- OK: There are no errors in the state of the specified symbol.
- UNK: An unknown error was detected for the specified symbol.
- DISPARITY = DISParity: A disparity error was detected for the specified symbol.
- GLITCH = GLITch: A glitch error was detected for the specified symbol.
"""
param = Conversions.value_to_quoted_str(search)
ebtbSymbol_cmd_val = self._cmd_group.get_repcap_cmd_value(ebtbSymbol, repcap.EbtbSymbol)
response = self._core.io.query_str(f'SEARch:RESult:EBTB:SYMBol{ebtbSymbol_cmd_val}:STATus? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusEbtbSymbolState)