uds.packet.abstract_packet
==========================

.. py:module:: uds.packet.abstract_packet

.. autoapi-nested-parse::

   Abstract definition of UDS packets that is common for all bus types.



Attributes
----------

.. autoapisummary::

   uds.packet.abstract_packet.PacketsContainersSequence
   uds.packet.abstract_packet.PacketsTuple
   uds.packet.abstract_packet.PacketsRecordsTuple
   uds.packet.abstract_packet.PacketsRecordsSequence


Classes
-------

.. autoapisummary::

   uds.packet.abstract_packet.AbstractUdsPacketContainer
   uds.packet.abstract_packet.AbstractUdsPacket
   uds.packet.abstract_packet.AbstractUdsPacketRecord


Module Contents
---------------

.. py:class:: AbstractUdsPacketContainer

   Bases: :py:obj:`abc.ABC`

   .. autoapi-inheritance-diagram:: uds.packet.abstract_packet.AbstractUdsPacketContainer
      :parts: 1
      :private-bases:


   Abstract definition of a container with UDS Packet information.


   .. py:property:: raw_frame_data
      :type: uds.utilities.RawBytesTupleAlias

      :abstractmethod:


      Raw data bytes of a frame that carries this packet.



   .. py:property:: addressing_type
      :type: uds.transmission_attributes.addressing.AddressingType

      :abstractmethod:


      Addressing for which this packet is relevant.



   .. py:property:: packet_type
      :type: uds.packet.abstract_packet_type.AbstractUdsPacketType

      :abstractmethod:


      Type (N_PCI value) of this UDS packet.



   .. py:property:: data_length
      :type: Optional[int]

      :abstractmethod:


      Payload bytes number of a diagnostic message which was carried by this packet.



   .. py:property:: payload
      :type: Optional[uds.utilities.RawBytesTupleAlias]

      :abstractmethod:


      Raw payload bytes of a diagnostic message that are carried by this packet.



.. py:class:: AbstractUdsPacket

   Bases: :py:obj:`AbstractUdsPacketContainer`

   .. autoapi-inheritance-diagram:: uds.packet.abstract_packet.AbstractUdsPacket
      :parts: 1
      :private-bases:


   Abstract definition of UDS Packet (Network Protocol Data Unit - N_PDU).


   .. py:property:: raw_frame_data
      :type: uds.utilities.RawBytesTupleAlias

      :abstractmethod:


      Raw data bytes of a frame that carries this packet.



   .. py:property:: addressing_type
      :type: uds.transmission_attributes.addressing.AddressingType

      :abstractmethod:


      Addressing for which this packet is relevant.



   .. py:property:: packet_type
      :type: uds.packet.abstract_packet_type.AbstractUdsPacketType

      :abstractmethod:


      Type (N_PCI value) of this UDS packet.



   .. py:property:: data_length
      :type: Optional[int]

      :abstractmethod:


      Payload bytes number of a diagnostic message which was carried by this packet.



   .. py:property:: payload
      :type: Optional[uds.utilities.RawBytesTupleAlias]

      :abstractmethod:


      Raw payload bytes of a diagnostic message that are carried by this packet.



.. py:class:: AbstractUdsPacketRecord(frame, direction, transmission_time)

   Bases: :py:obj:`AbstractUdsPacketContainer`

   .. autoapi-inheritance-diagram:: uds.packet.abstract_packet.AbstractUdsPacketRecord
      :parts: 1
      :private-bases:


   Abstract definition of a storage for historic information about transmitted or received UDS Packet.

   Create a record of historic information about a packet that was either received or transmitted.

   :param frame: Frame that carried this UDS packet.
   :param direction: Information whether this packet was transmitted or received.
   :param transmission_time: Time stamp when this packet was fully transmitted on a bus.


   .. py:property:: frame
      :type: Any


      Frame that carried this packet.



   .. py:property:: direction
      :type: uds.transmission_attributes.transmission_direction.TransmissionDirection


      Information whether this packet was transmitted or received.



   .. py:property:: transmission_time
      :type: datetime.datetime


      Time when this packet was fully transmitted on a bus.



   .. py:property:: raw_frame_data
      :type: uds.utilities.RawBytesTupleAlias

      :abstractmethod:


      Raw data bytes of a frame that carries this packet.



   .. py:property:: addressing_type
      :type: uds.transmission_attributes.addressing.AddressingType

      :abstractmethod:


      Addressing for which this packet is relevant.



   .. py:property:: packet_type
      :type: uds.packet.abstract_packet_type.AbstractUdsPacketType

      :abstractmethod:


      Type (N_PCI value) of this UDS packet.



   .. py:property:: data_length
      :type: Optional[int]

      :abstractmethod:


      Payload bytes number of a diagnostic message which was carried by this packet.



   .. py:property:: payload
      :type: Optional[uds.utilities.RawBytesTupleAlias]

      :abstractmethod:


      Raw payload bytes of a diagnostic message that are carried by this packet.



   .. py:method:: _validate_frame(value)
      :staticmethod:

      :abstractmethod:


      Validate a frame argument.

      :param value: Value to validate.

      :raise TypeError: Provided frame object has unsupported type.
      :raise ValueError: At least one attribute of the frame object is missing or its value is unexpected.



.. py:data:: PacketsContainersSequence

   Alias for a sequence filled with packet or packet record object.


.. py:data:: PacketsTuple

   Alias for a packet objects tuple.


.. py:data:: PacketsRecordsTuple

   Alias for a packet record objects tuple.


.. py:data:: PacketsRecordsSequence

   Alias for a packet record objects sequence.