bluemira.base.error
===================

.. py:module:: bluemira.base.error

.. autoapi-nested-parse::

   Bluemira base error class



Exceptions
----------

.. autoapisummary::

   bluemira.base.error.BluemiraError
   bluemira.base.error.BuilderError
   bluemira.base.error.ComponentError
   bluemira.base.error.LogsError
   bluemira.base.error.ParameterError
   bluemira.base.error.DesignError
   bluemira.base.error.ReactorError
   bluemira.base.error.ReactorConfigError


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

.. py:exception:: BluemiraError

   Bases: :py:obj:`Exception`

   .. autoapi-inheritance-diagram:: bluemira.base.error.BluemiraError
      :parts: 1
      :private-bases:


   Base exception class. Sub-class from this for module level Errors.


   .. py:method:: __str__() -> str

      Prettier handling of the Exception strings.

      :returns: The formatted exception string.



.. py:exception:: BuilderError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.BuilderError
      :parts: 1
      :private-bases:


   Exception class for Builders.


.. py:exception:: ComponentError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.ComponentError
      :parts: 1
      :private-bases:


   Exception class for Components.


.. py:exception:: LogsError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.LogsError
      :parts: 1
      :private-bases:


   Exception class for Components.


.. py:exception:: ParameterError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.ParameterError
      :parts: 1
      :private-bases:


   Exception class for Parameters.


.. py:exception:: DesignError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.DesignError
      :parts: 1
      :private-bases:


   Exception class for Designs.


.. py:exception:: ReactorError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.ReactorError
      :parts: 1
      :private-bases:


   Exceptions related to :class:`bluemira.base.reactor.Reactor` objects.


.. py:exception:: ReactorConfigError

   Bases: :py:obj:`BluemiraError`

   .. autoapi-inheritance-diagram:: bluemira.base.error.ReactorConfigError
      :parts: 1
      :private-bases:


   Exceptions related to
   :class:`bluemira.base.reactor_config.ReactorConfig` objects.