from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class NumPacketsCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("numPackets", core, parent)
[docs]
def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default) -> int:
"""
``BUS<*>:DPHY:RESult:FRAMe<*>:NUMPackets`` \n
Snippet: ``value: int = driver.bus.dphy.result.frame.numPackets.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the number of packets in the indicated frame.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:return: num_packets: 0 to 4.29497E+9
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:DPHY:RESult:FRAMe{busFrameNull_cmd_val}:NUMPackets?')
return Conversions.str_to_int(response)