pyHarm.Substructures.SubDataReader.GenericReader
================================================

.. py:module:: pyHarm.Substructures.SubDataReader.GenericReader


Classes
-------

.. autoapisummary::

   pyHarm.Substructures.SubDataReader.GenericReader.GenericReader


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

.. py:class:: GenericReader

   Bases: :py:obj:`pyHarm.Substructures.SubDataReader.ABCReader.ABCReader`


   Generic read is the basic substructure reader in pyHarm. It can read '.mat', '.h5' files and complete the input dictionary as well as reading already completed input dictionary (containing all the matrices)

   .. attribute:: factory_keyword

      keyword to be called when instantiating the object through the factory.

      :type: str


   .. py:attribute:: factory_keyword
      :value: 'generic'


      Factory keyword to be used when instantiating a reader


   .. py:method:: data_complete(data: dict) -> dict

      Reads and completes the input dictionary from the file.

      :param data: input dictionary.
      :type data: dict

      :returns: Returns a completed version of the input data dictionary.
      :rtype: dict



   .. py:method:: read_and_complete_matrix(data)

      Reads and completes the 'matrix' input dictionary value from the input dictionary.

      :param data: input dictionary.
      :type data: dict

      :returns: Returns a completed version of the input data dictionary.
      :rtype: dict



   .. py:method:: read_mat_files(filename, data)

      Reads and completes the 'matrix' input dictionary value from the input dictionary when a .mat file is required to be read.

      :param data: input dictionary.
      :type data: dict

      :returns: Returns a completed version of the input data dictionary.
      :rtype: dict



   .. py:method:: read_h5_files(filename, data)

      Reads and completes the 'matrix' input dictionary value from the input dictionary when a .h5 file is required to be read.

      :param data: input dictionary.
      :type data: dict

      :returns: Returns a completed version of the input data dictionary.
      :rtype: dict