uds.utilities.custom_warnings
=============================

.. py:module:: uds.utilities.custom_warnings

.. autoapi-nested-parse::

   Custom warnings that are used within the project.



Exceptions
----------

.. autoapisummary::

   uds.utilities.custom_warnings.UnusedArgumentWarning
   uds.utilities.custom_warnings.ValueWarning
   uds.utilities.custom_warnings.UnexpectedPacketReceptionWarning
   uds.utilities.custom_warnings.NewMessageReceptionWarning


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

.. py:exception:: UnusedArgumentWarning

   Bases: :py:obj:`Warning`

   .. autoapi-inheritance-diagram:: uds.utilities.custom_warnings.UnusedArgumentWarning
      :parts: 1
      :private-bases:


   At least one argument (that was provided by user) will be ignored.

   It is meant to be used in less strict situation than :class:`~uds.utilities.custom_exceptions.UnusedArgumentError`.

   Example:
       A function takes two parameters: a, b

       Let's assume that parameter `a` must always be provided. Parameter `b` is used only when `a == 1`.

       The function would warn (using this warning) when both parameters are provided but `a != 1`.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: ValueWarning

   Bases: :py:obj:`Warning`

   .. autoapi-inheritance-diagram:: uds.utilities.custom_warnings.ValueWarning
      :parts: 1
      :private-bases:


   Value of the argument is out of typical range, but the package is able to handle it.

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: UnexpectedPacketReceptionWarning

   Bases: :py:obj:`RuntimeWarning`

   .. autoapi-inheritance-diagram:: uds.utilities.custom_warnings.UnexpectedPacketReceptionWarning
      :parts: 1
      :private-bases:


   An unexpected packet was received.

   .. seealso:: :ref:`Unexpected CAN Packet handling <knowledge-base-can-unexpected-packet-arrival>`

   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: NewMessageReceptionWarning

   Bases: :py:obj:`RuntimeWarning`

   .. autoapi-inheritance-diagram:: uds.utilities.custom_warnings.NewMessageReceptionWarning
      :parts: 1
      :private-bases:


   A new message transmission was started while in process of receiving another message.

   .. seealso::
       :ref:`Unexpected CAN Packet handling <knowledge-base-can-unexpected-packet-arrival>`

   Initialize self.  See help(type(self)) for accurate signature.