uds.addressing.abstract_addressing_information
==============================================

.. py:module:: uds.addressing.abstract_addressing_information

.. autoapi-nested-parse::

   Definition of UDS Addressing Information for storing Client/Server Addresses.



Classes
-------

.. autoapisummary::

   uds.addressing.abstract_addressing_information.AbstractAddressingInformation


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

.. py:class:: AbstractAddressingInformation(rx_physical_params, tx_physical_params, rx_functional_params, tx_functional_params)

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

   .. autoapi-inheritance-diagram:: uds.addressing.abstract_addressing_information.AbstractAddressingInformation
      :parts: 1
      :private-bases:


   Storage for addressing related parameters for any UDS entity.

   Configure Addresses of UDS Entity (either a server or a client).

   :param rx_physical_params: Addressing parameters for incoming physically addressed communication.
   :param tx_physical_params: Addressing parameters for outgoing physically addressed communication.
   :param rx_functional_params: Addressing parameters for incoming functionally addressed communication.
   :param tx_functional_params: Addressing parameters for outgoing functionally addressed communication.


   .. py:attribute:: ADDRESSING_TYPE_NAME
      :type:  str
      :value: 'addressing_type'


      Name of :ref:`Addressing Type <knowledge-base-addressing>` parameter in Addressing Information.



   .. py:property:: rx_physical_params
      :type: Mapping[str, Any]


      Get addressing parameters for incoming physically addressed communication.



   .. py:property:: tx_physical_params
      :type: Mapping[str, Any]


      Get addressing parameters for outgoing physically addressed communication.



   .. py:property:: rx_functional_params
      :type: Mapping[str, Any]


      Get addressing parameters for incoming functionally addressed communication.



   .. py:property:: tx_functional_params
      :type: Mapping[str, Any]


      Get addressing parameters for outgoing functionally addressed communication.



   .. py:method:: __eq__(other)

      Compare with other object.

      :param other: Object to compare.

      :return: True if other object has the same type and carries the same Addressing Information, otherwise False.



   .. py:method:: _validate_addressing_information()
      :abstractmethod:


      Check whether the provided addressing information are valid.



   .. py:method:: validate_addressing_params(**addressing_params)
      :abstractmethod:


      Check whether the provided parameters are complete and correct.



   .. py:method:: is_input_packet(**frame_attributes)
      :abstractmethod:


      Check if a frame with provided attributes is an input packet for this UDS Entity.

      :param frame_attributes: Attributes of a frame to be checked.

      :return: Addressing Type used for transmission of this packet, None otherwise.



   .. py:method:: get_other_end()

      Get Addressing Information of UDS entity on the other end of UDS communication.

      :return: UDS Addressing Information of a UDS entity that this one communicates with.