from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class IdxCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("idx", core, parent)
[docs]
def get(self, search: str, busFrameNull=repcap.BusFrameNull.Default, busUsbPacket=repcap.BusUsbPacket.Default) -> int:
"""
``SEARch:RESult:DPHY:FRAMe<*>:PACKet<*>:IDX`` \n
Snippet: ``value: int = driver.search.result.dphy.frame.packet.idx.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default, busUsbPacket = repcap.BusUsbPacket.Default)`` \n
Returns the index of the data payload for the selected frame within the search result.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busUsbPacket: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Packet')
:return: packet_index: 0 to 4.29497E+9
"""
param = Conversions.value_to_quoted_str(search)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busUsbPacket_cmd_val = self._cmd_group.get_repcap_cmd_value(busUsbPacket, repcap.BusUsbPacket)
response = self._core.io.query_str(f'SEARch:RESult:DPHY:FRAMe{busFrameNull_cmd_val}:PACKet{busUsbPacket_cmd_val}:IDX? {param}')
return Conversions.str_to_int(response)