pyHarm.Systems.FactorySystem
============================

.. py:module:: pyHarm.Systems.FactorySystem

.. autoapi-nested-parse::

   Module that defines the Factory of the package.

   .. attribute:: System_dico

      Dictionary containing the available ABCSystem in pyHarm for creation as values and their factory_keyword as keys.

      :type: dict[str,ABCSystem]



Attributes
----------

.. autoapisummary::

   pyHarm.Systems.FactorySystem.System_dico


Functions
---------

.. autoapisummary::

   pyHarm.Systems.FactorySystem.generateSystem


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

.. py:data:: System_dico

   Dictionary containing the available ABCSystem in pyHarm for creation as values and their factory_keyword as keys.

   :type: dict[str,ABCSystem]

.. py:function:: generateSystem(name_system: str, datas: dict) -> pyHarm.Systems.ABCSystem.ABCSystem

   Factory function that creates a ABCSystem object.

   :param name_system: Type of the system object that is to be instantiated.
   :type name_system: str
   :param datas: dictionary containing the inputs that are needed to create a system.
   :type datas: dict

   :returns: Instance of the required ABCSystem class.
   :rtype: ABCSystem