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, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> enums.BusUsb3ResultState:
"""
``SEARch:RESult:USBThree:FRAMe<*>:FLD<*>:STATus`` \n
Snippet: ``value: enums.BusUsb3ResultState = driver.search.result.usbThree.frame.fld.status.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Returns the field status of the field with the selected field number within the frame with the selected frame number
within the search result.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busFieldNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Fld')
:return: field_state: OK | INComplete | UNCorrelated | UNKNown | AMB | CRC | LENGth | VOOR | SYMB \n
- VOOR: Value out of range
"""
param = Conversions.value_to_quoted_str(search)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busFieldNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFieldNull, repcap.BusFieldNull)
response = self._core.io.query_str(f'SEARch:RESult:USBThree:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:STATus? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusUsb3ResultState)