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, searchResCmsb=repcap.SearchResCmsb.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> enums.BusCmsbResultState:
"""
``SEARch:RESult:CMSB<*>:FRAMe<*>:CELL<*>:STATe`` \n
Snippet: ``value: enums.BusCmsbResultState = driver.search.result.cmsb.frame.cell.state.get(search = 'abc', searchResCmsb = repcap.SearchResCmsb.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
Returns the state of the cell within the search result.
:param searchResCmsb: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cmsb')
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busCellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell')
:return: state: OK | LENGth | UNKNown | INComplete | CRC | PARity \n
- OK: No error detected
- LENGth: The length error indicates that the cell ended prematurely. The amount of bits that the software expected (based upon the user's frame description) was not found before the cell was terminated. This might occur because a new frame synchronized, or a gap appeared between the bits.
- UNKNown: Unknown error
- INComplete: The cell ended prematurely because it extends past the end of the record.
- CRC: Checksum error in cyclic redundancy check (error in data)
- PARity: Parity bit error, indicating a transmission error (only available if a parity is configured)
"""
param = Conversions.value_to_quoted_str(search)
searchResCmsb_cmd_val = self._cmd_group.get_repcap_cmd_value(searchResCmsb, repcap.SearchResCmsb)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busCellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busCellNull, repcap.BusCellNull)
response = self._core.io.query_str(f'SEARch:RESult:CMSB{searchResCmsb_cmd_val}:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:STATe? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusCmsbResultState)