pyHarm.Systems.FactorySystem¶

Module that defines the Factory of the package.

pyHarm.Systems.FactorySystem.System_dico¶

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

Type:: dict[str,ABCSystem]

Attributes¶

System_dico

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

Functions¶

`check_and_repair_system_input`(→ dict)	Check and repair the input dictionnary for systems in order to ensure proper functining.
`generateSystem`(→ pyHarm.Systems.ABCSystem.ABCSystem)	Factory function that creates a ABCSystem object.

Module Contents¶

pyHarm.Systems.FactorySystem.System_dico¶

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

Type:: dict[str,ABCSystem]

pyHarm.Systems.FactorySystem.check_and_repair_system_input(data: dict, logger: logging.Logger) → dict¶

Check and repair the input dictionnary for systems in order to ensure proper functining.

Parameters:: data (dict) – input dict provided to the maestro.
Returns:: repaired data dictionnary
Return type:: dict

pyHarm.Systems.FactorySystem.generateSystem(name_system: str, datas: dict, logger: logging.Logger | None = None) → pyHarm.Systems.ABCSystem.ABCSystem¶

Factory function that creates a ABCSystem object.

Parameters:

name_system (str) – Type of the system object that is to be instantiated.
datas (dict) – dictionary containing the inputs that are needed to create a system.

Returns:

Instance of the required ABCSystem class.

Return type:

ABCSystem