Source code for rsrtx.Implementations.Bus.Pcie.Result.Packet.Cps

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 CpsCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("cps", core, parent)

	# noinspection PyTypeChecker
[docs] def get(self, bus=repcap.Bus.Default, busUsbPacket=repcap.BusUsbPacket.Default) -> enums.BusPcieCplStatus: """ ``BUS<*>:PCIE:RESult:PACKet<*>:CPS`` \n Snippet: ``value: enums.BusPcieCplStatus = driver.bus.pcie.result.packet.cps.get(bus = repcap.Bus.Default, busUsbPacket = repcap.BusUsbPacket.Default)`` \n Returns the completion status field value of the specified packet. :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') :param busUsbPacket: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Packet') :return: cpl_status: RESERVED | SC | UR | CRS | CA \n - RESERVED: Others - SC: Successful Completion - UR: Unsupported Request - CRS: Configuration Request Retry Status - CA: Completer Abort """ bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus) busUsbPacket_cmd_val = self._cmd_group.get_repcap_cmd_value(busUsbPacket, repcap.BusUsbPacket) response = self._core.io.query_str(f'BUS{bus_cmd_val}:PCIE:RESult:PACKet{busUsbPacket_cmd_val}:CPS?') return Conversions.str_to_scalar_enum(response, enums.BusPcieCplStatus)