:py:mod:`eelib.data.dataclass._base`
====================================

.. py:module:: eelib.data.dataclass._base

.. autoapi-nested-parse::

   Base Class for Dataclasses used in eELib.

   | Author: elenia@TUBS
   | Copyright 2024 elenia
   | This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.



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

Classes
~~~~~~~

.. autoapisummary::

   eelib.data.dataclass._base.BaseData




.. py:class:: BaseData


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

   Baseclass for Dataclasses.

   .. py:method:: check_adaption_tolerance(adaption_tolerance: float, dict_cache: dict, dict_to_check: dict = None) -> bool

      Compares the input data with its cache based on the individual values.

      :param adaption_tolerance: fixed adaption tolerance for comparison of values
      :type adaption_tolerance: float
      :param dict_cache: cached dataclass to be compared
      :type dict_cache: dict
      :param dict_to_check: Subdict to be checked, substitutes dataclass if existent. Defaults
                            to None.
      :type dict_to_check: dict

      :raises TypeError: if format for dataclass value is unknown

      :returns: True if value of new dataclass has changed
      :rtype: bool