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 PidCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pid", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, search: str, busUsbPacket=repcap.BusUsbPacket.Default) -> enums.BusUsbPid:
"""
``SEARch:RESult:USB:PACKet<*>:PID`` \n
Snippet: ``value: enums.BusUsbPid = driver.search.result.usb.packet.pid.get(search = 'abc', busUsbPacket = repcap.BusUsbPacket.Default)`` \n
Returns the packet PID for the selected packet number within the search result.
:param busUsbPacket: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Packet')
:return: pid: For a description of the return values, see method ``RsRtx.bus.usb.packet.pid.get()``.
"""
param = Conversions.value_to_quoted_str(search)
busUsbPacket_cmd_val = self._cmd_group.get_repcap_cmd_value(busUsbPacket, repcap.BusUsbPacket)
response = self._core.io.query_str(f'SEARch:RESult:USB:PACKet{busUsbPacket_cmd_val}:PID? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusUsbPid)