uds.packet.can.abstract_can_container
=====================================

.. py:module:: uds.packet.can.abstract_can_container

.. autoapi-nested-parse::

   Abstract definition of CAN packets container.



Classes
-------

.. autoapisummary::

   uds.packet.can.abstract_can_container.AbstractCanPacketContainer


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

.. py:class:: AbstractCanPacketContainer

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

   .. autoapi-inheritance-diagram:: uds.packet.can.abstract_can_container.AbstractCanPacketContainer
      :parts: 1
      :private-bases:


   Abstract definition of CAN Packets containers.


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

      :abstractmethod:


      Raw data bytes of a CAN frame that carries this CAN packet.



   .. py:property:: can_id
      :type: int

      :abstractmethod:


      CAN Identifier (CAN ID) of a CAN Frame that carries this CAN packet.



   .. py:property:: addressing_format
      :type: uds.can.CanAddressingFormat

      :abstractmethod:


      CAN addressing format used by this CAN packet.



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

      :abstractmethod:


      Addressing type for which this CAN packet is relevant.



   .. py:property:: dlc
      :type: int


      Value of Data Length Code (DLC) of a CAN Frame that carries this CAN packet.



   .. py:property:: packet_type
      :type: uds.packet.can.can_packet_type.CanPacketType


      Type (N_PCI value) of this CAN packet.



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


      Target Address (TA) value of this CAN Packet.

      Target Address value is used with following :ref:`addressing formats <knowledge-base-can-addressing>`:
       - :ref:`Normal Fixed Addressing <knowledge-base-can-normal-fixed-addressing>`
       - :ref:`Extended Addressing <knowledge-base-can-extended-addressing>`
       - :ref:`Mixed 29-bit Addressing <knowledge-base-can-mixed-29-bit-addressing>`

      None in other cases.



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


      Source Address (SA) value of this CAN Packet.

      Source Address value is used with following :ref:`addressing formats <knowledge-base-can-addressing>`:
       - :ref:`Normal Fixed Addressing <knowledge-base-can-normal-fixed-addressing>`
       - :ref:`Mixed 29-bit Addressing <knowledge-base-can-mixed-29-bit-addressing>`

      None in other cases.



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


      Address Extension (AE) value of this CAN Packet.

      Address Extension is used with following :ref:`addressing formats <knowledge-base-can-addressing>`:
       - :ref:`Mixed Addressing <knowledge-base-can-mixed-addressing>` - either:
         - :ref:`Mixed 11-bit Addressing <knowledge-base-can-mixed-11-bit-addressing>`
         - :ref:`Mixed 29-bit Addressing <knowledge-base-can-mixed-29-bit-addressing>`

      None in other cases.



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


      Payload bytes number of a diagnostic message that is carried by this CAN packet.

      Data length is only provided by packets of following types:
       - :ref:`Single Frame <knowledge-base-can-single-frame>` -
         :ref:`Single Frame Data Length <knowledge-base-can-single-frame-data-length>`
       - :ref:`First Frame <knowledge-base-can-first-frame>` -
         :ref:`First Frame Data Length <knowledge-base-can-first-frame-data-length>`

      None in other cases.



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


      Sequence Number carried by this CAN packet.

      :ref:`Sequence Number <knowledge-base-can-sequence-number>` is only provided by packets of following types:
       - :ref:`Consecutive Frame <knowledge-base-can-consecutive-frame>`

      None in other cases.



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


      Diagnostic message payload carried by this CAN packet.

      Payload is only provided by packets of following types:
       - :ref:`Single Frame <knowledge-base-can-single-frame>`
       - :ref:`First Frame <knowledge-base-can-first-frame>`
       - :ref:`Consecutive Frame <knowledge-base-can-consecutive-frame>`

      None in other cases.

      .. warning:: For :ref:`Consecutive Frames <knowledge-base-can-consecutive-frame>` this value might contain
          additional filler bytes (they are not part of diagnostic message payload) that were added during
          :ref:`CAN Frame Data Padding <knowledge-base-can-frame-data-padding>`.
          The presence of filler bytes in :ref:`Consecutive Frame <knowledge-base-can-consecutive-frame>`
          cannot be determined basing solely on the information contained in this packet object.



   .. py:property:: flow_status
      :type: Optional[uds.can.CanFlowStatus]


      Flow Status carried by this CAN packet.

      :ref:`Flow Status <knowledge-base-can-flow-status>` is only provided by packets of following types:
       - :ref:`Flow Control <knowledge-base-can-flow-control>`

      None in other cases.



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


      Block Size value carried by this CAN packet.

      :ref:`Block Size <knowledge-base-can-flow-status>` is only provided by packets of following types:
       - :ref:`Flow Control <knowledge-base-can-block-size>`

      None in other cases.



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


      Separation Time minimum (STmin) value carried by this CAN packet.

      :ref:`STmin <knowledge-base-can-st-min>` is only provided by packets of following types:
       - :ref:`Flow Control <knowledge-base-can-block-size>`

      None in other cases.



   .. py:method:: get_addressing_information()

      Get Addressing Information carried by this packet.

      :return: Addressing Information decoded from CAN ID and CAN Frame data of this packet.