lib.adf_base
============

.. py:module:: lib.adf_base

.. autoapi-nested-parse::

   Base class for the Atmospheric
   Diagnostics Framework (ADF).  All
   other ADF classes inherit from this
   class.

   Currently this class only does two things:

   1.  Creates a debug logger, if requested.

   2.  Defines an ADF-specific function to end
       the diagnostics program, if need be.



Exceptions
----------

.. autoapisummary::

   lib.adf_base.AdfError


Classes
-------

.. autoapisummary::

   lib.adf_base.AdfBase


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

.. py:exception:: AdfError

   Bases: :py:obj:`RuntimeError`


   Class used to handle ADF value errors
   (e.g., log user errors without backtrace)


.. py:class:: AdfBase(debug=False)

   Base class for the ADF


   .. py:attribute:: __debug_fname
      :value: ''



   .. py:property:: debug_fname

      Return the "debug_fname" string to the user.


   .. py:method:: debug_log(msg: str)

      Write message to debug log, if enabled.



   .. py:method:: end_diag_fail(msg: str)

      Prints message to log and screen,
      and then exits program with an
      ADF-specific error.