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, busFieldNull=repcap.BusFieldNull.Default) -> enums.I3cFrameState:
"""
``SEARch:RESult:I3C:FRAMe<*>:FLD<*>:STATe`` \n
Snippet: ``value: enums.I3cFrameState = driver.search.result.i3C.frame.fld.state.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Returns the overall state of the specified field for the selected frame.
: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: state: OK | ACK | PAR | CRC | LENGth | UNKNown | INComplete \n
- OK: The field has no error, it is valid.
- ACK: Wrong acknowledgment (ACK) delimiter occurred.
- PAR: Wrong parity detected.
- CRC: Cyclic redundancy check failed.
- LENGth: Wrong length of the field.
- UNKNown: Unknown field type detected.
- INComplete: The field is not completely contained in the acquisition. The acquired part of the field is usually valid, but cannot always be trusted.
"""
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:I3C:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:STATe? {param}')
return Conversions.str_to_scalar_enum(response, enums.I3cFrameState)