opengate.exception
==================

.. py:module:: opengate.exception


Attributes
----------

.. autoapisummary::

   opengate.exception.color_error
   opengate.exception.color_warning
   opengate.exception.color_ok


Exceptions
----------

.. autoapisummary::

   opengate.exception.GateDeprecationError
   opengate.exception.GateFeatureUnavailableError
   opengate.exception.GateImplementationError


Classes
-------

.. autoapisummary::

   opengate.exception.ExceptionHandler


Functions
---------

.. autoapisummary::

   opengate.exception.fatal
   opengate.exception.warning
   opengate.exception.raise_except


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

.. py:exception:: GateDeprecationError

   Bases: :py:obj:`Exception`


   Raise this if a deprecated feature is used.
   Provide the user with information on how to update their code.


.. py:exception:: GateFeatureUnavailableError

   Bases: :py:obj:`Exception`


   Raise this if a feature is used that is (currently) unavailable.
   Ideally, provide the user with information about alternatives.
   Can be used as temporary workaround during refactorings.


.. py:exception:: GateImplementationError

   Bases: :py:obj:`Exception`


   Raise this if a feature is used that is (currently) unavailable.
   Ideally, provide the user with information about alternatives.
   Can be used as temporary workaround during refactorings.


.. py:data:: color_error

.. py:data:: color_warning

.. py:data:: color_ok

.. py:function:: fatal(s)

.. py:function:: warning(s)

.. py:function:: raise_except(s)

.. py:class:: ExceptionHandler

   Bases: :py:obj:`opengate_core.GateExceptionHandler`


   Geant4 exception handler. Inherit form GateExceptionHandler
   The function 'Notify' will be called by G4 when an exception occurs.
   Should be created after initialization.
   Will be automatically stored in the G4 stateManager


   .. py:method:: Notify(originOfException, exceptionCode, severity, description)