pyHarm.Substructures.SubDataReader.FactoryReader
================================================

.. py:module:: pyHarm.Substructures.SubDataReader.FactoryReader

.. autoapi-nested-parse::

   This module is the factory of the Substructure Readers.

   .. attribute:: SubstructureReaderDictionary

      Dictionary of available Substructure reader subclasses as values and their factory_keyword as key.

      :type: dict[str, ABCReader]



Attributes
----------

.. autoapisummary::

   pyHarm.Substructures.SubDataReader.FactoryReader.SubstructureReaderDictionary


Functions
---------

.. autoapisummary::

   pyHarm.Substructures.SubDataReader.FactoryReader.generate_subreader


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

.. py:data:: SubstructureReaderDictionary

   Dictionary of available Substructure readers subclasses as values and their factory_keyword as key.

   :type: dict[str, ABCReader]

.. py:function:: generate_subreader(data: dict) -> pyHarm.Substructures.SubDataReader.ABCReader.ABCReader

   Function responsible for the instantiation of ABCReader objects.

   :param data: input dictionary
   :type data: dict

   :returns: Instance of a subclass of ABCReader class.
   :rtype: ABCReader