Minor documentation and code review corrections (38)

[modules/adao.git] / src / daComposant / daCore / Aidsm.py

diff --git a/src/daComposant/daCore/Aidsm.py b/src/daComposant/daCore/Aidsm.py
index b05b1889033e20ed508e3a51015e61819025de22..256c38a765483378a4d8f87d6fc51793d6db9f2b 100644 (file)
--- a/src/daComposant/daCore/Aidsm.py
+++ b/src/daComposant/daCore/Aidsm.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
 # -*- coding: utf-8 -*-
 #

-# Copyright (C) 2008-2022 EDF R&D
+# Copyright (C) 2008-2023 EDF R&D

 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public


@@ -124,7 +124,7 @@ class Aidsm(object):
             Vector               = None,
             VectorSerie          = None,
             ):
             Vector               = None,
             VectorSerie          = None,
             ):

-        "Interface unique de definition de variables d'entrees par argument"
+        "Interface unique de définition de variables d'entrées par argument"

         self.__case.register("set",dir(),locals(),None,True)
         try:
             if   Concept in ("Background", "CheckingPoint", "ControlInput", "Observation"):
         self.__case.register("set",dir(),locals(),None,True)
         try:
             if   Concept in ("Background", "CheckingPoint", "ControlInput", "Observation"):


@@ -166,7 +166,7 @@ class Aidsm(object):
             else:
                 raise ValueError("the variable named '%s' is not allowed."%str(Concept))
         except Exception as e:
             else:
                 raise ValueError("the variable named '%s' is not allowed."%str(Concept))
         except Exception as e:

-            if isinstance(e, SyntaxError): msg = "at %s: %s"%(e.offset, e.text)
+            if isinstance(e, SyntaxError): msg = " at %s: %s"%(e.offset, e.text)

             else: msg = ""
             raise ValueError(("during settings, the following error occurs:\n"+\
                               "\n%s%s\n\nSee also the potential messages, "+\
             else: msg = ""
             raise ValueError(("during settings, the following error occurs:\n"+\
                               "\n%s%s\n\nSee also the potential messages, "+\


@@ -185,7 +185,7 @@ class Aidsm(object):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "Background"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(
         Concept = "Background"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(


@@ -213,7 +213,7 @@ class Aidsm(object):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "CheckingPoint"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(
         Concept = "CheckingPoint"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(


@@ -241,7 +241,7 @@ class Aidsm(object):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "ControlInput"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(
         Concept = "ControlInput"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(


@@ -269,7 +269,7 @@ class Aidsm(object):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):
             Stored         = False,
             Scheduler      = None,
             Checked        = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "Observation"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(
         Concept = "Observation"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = State(


@@ -295,7 +295,7 @@ class Aidsm(object):
             Stored               = False,
             ObjectMatrix         = None,
             Checked              = False):
             Stored               = False,
             ObjectMatrix         = None,
             Checked              = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "BackgroundError"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = Covariance(
         Concept = "BackgroundError"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = Covariance(


@@ -319,7 +319,7 @@ class Aidsm(object):
             Stored               = False,
             ObjectMatrix         = None,
             Checked              = False):
             Stored               = False,
             ObjectMatrix         = None,
             Checked              = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "ObservationError"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = Covariance(
         Concept = "ObservationError"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = Covariance(


@@ -343,7 +343,7 @@ class Aidsm(object):
             Stored               = False,
             ObjectMatrix         = None,
             Checked              = False):
             Stored               = False,
             ObjectMatrix         = None,
             Checked              = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "EvolutionError"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = Covariance(
         Concept = "EvolutionError"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = Covariance(


@@ -371,7 +371,7 @@ class Aidsm(object):
             PerformanceProfile   = None,
             InputFunctionAsMulti = False,
             Checked              = False):
             PerformanceProfile   = None,
             InputFunctionAsMulti = False,
             Checked              = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "ObservationOperator"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = FullOperator(
         Concept = "ObservationOperator"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = FullOperator(


@@ -404,7 +404,7 @@ class Aidsm(object):
             PerformanceProfile   = None,
             InputFunctionAsMulti = False,
             Checked              = False):
             PerformanceProfile   = None,
             InputFunctionAsMulti = False,
             Checked              = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "EvolutionModel"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = FullOperator(
         Concept = "EvolutionModel"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = FullOperator(


@@ -437,7 +437,7 @@ class Aidsm(object):
             PerformanceProfile   = None,
             InputFunctionAsMulti = False,
             Checked              = False):
             PerformanceProfile   = None,
             InputFunctionAsMulti = False,
             Checked              = False):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "ControlModel"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = FullOperator(
         Concept = "ControlModel"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = FullOperator(


@@ -459,7 +459,7 @@ class Aidsm(object):
         return 0
 
     def setName(self, String=None):
         return 0
 
     def setName(self, String=None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         self.__case.register("setName",dir(),locals())
         if String is not None:
             self.__name = str(String)
         self.__case.register("setName",dir(),locals())
         if String is not None:
             self.__name = str(String)


@@ -468,7 +468,7 @@ class Aidsm(object):
         self.__StoredInputs["Name"] = self.__name
 
     def setDirectory(self, String=None):
         self.__StoredInputs["Name"] = self.__name
 
     def setDirectory(self, String=None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         self.__case.register("setDirectory",dir(),locals())
         if os.path.isdir(os.path.abspath(str(String))):
             self.__directory = os.path.abspath(str(String))
         self.__case.register("setDirectory",dir(),locals())
         if os.path.isdir(os.path.abspath(str(String))):
             self.__directory = os.path.abspath(str(String))


@@ -498,7 +498,7 @@ class Aidsm(object):
             Algorithm  = None,
             Parameters = None,
             Script     = None):
             Algorithm  = None,
             Parameters = None,
             Script     = None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "AlgorithmParameters"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = AlgorithmAndParameters(
         Concept = "AlgorithmParameters"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = AlgorithmAndParameters(


@@ -512,7 +512,7 @@ class Aidsm(object):
     def updateAlgorithmParameters(self,
             Parameters = None,
             Script     = None):
     def updateAlgorithmParameters(self,
             Parameters = None,
             Script     = None):

-        "Mise a jour d'un concept de calcul"
+        "Mise à jour d'un concept de calcul"

         Concept = "AlgorithmParameters"
         if Concept not in self.__adaoObject or self.__adaoObject[Concept] is None:
             raise ValueError("\n\nNo algorithm registred, set one before updating parameters or executing\n")
         Concept = "AlgorithmParameters"
         if Concept not in self.__adaoObject or self.__adaoObject[Concept] is None:
             raise ValueError("\n\nNo algorithm registred, set one before updating parameters or executing\n")


@@ -527,7 +527,7 @@ class Aidsm(object):
             Algorithm  = None,
             Parameters = None,
             Script     = None):
             Algorithm  = None,
             Parameters = None,
             Script     = None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "RegulationParameters"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = RegulationAndParameters(
         Concept = "RegulationParameters"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = RegulationAndParameters(


@@ -541,7 +541,7 @@ class Aidsm(object):
     def setSupplementaryParameters(self,
             Parameters = None,
             Script     = None):
     def setSupplementaryParameters(self,
             Parameters = None,
             Script     = None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "SupplementaryParameters"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = ExternalParameters(
         Concept = "SupplementaryParameters"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept] = ExternalParameters(


@@ -554,7 +554,7 @@ class Aidsm(object):
     def updateSupplementaryParameters(self,
             Parameters = None,
             Script     = None):
     def updateSupplementaryParameters(self,
             Parameters = None,
             Script     = None):

-        "Mise a jour d'un concept de calcul"
+        "Mise à jour d'un concept de calcul"

         Concept = "SupplementaryParameters"
         if Concept not in self.__adaoObject or self.__adaoObject[Concept] is None:
             self.__adaoObject[Concept] = ExternalParameters(name = Concept)
         Concept = "SupplementaryParameters"
         if Concept not in self.__adaoObject or self.__adaoObject[Concept] is None:
             self.__adaoObject[Concept] = ExternalParameters(name = Concept)


@@ -572,7 +572,7 @@ class Aidsm(object):
             Info           = None,
             ObjectFunction = None,
             Scheduler      = None):
             Info           = None,
             ObjectFunction = None,
             Scheduler      = None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "Observer"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept].append( DataObserver(
         Concept = "Observer"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept].append( DataObserver(


@@ -592,7 +592,7 @@ class Aidsm(object):
             Variable       = None,
             ObjectFunction = None,
             ):
             Variable       = None,
             ObjectFunction = None,
             ):

-        "Permet de retirer un observer à une ou des variable nommée"
+        "Permet de retirer un observer à une ou des variable nommées"

         if "AlgorithmParameters" not in self.__adaoObject:
             raise ValueError("No algorithm registred, ask for one before removing observers")
         #
         if "AlgorithmParameters" not in self.__adaoObject:
             raise ValueError("No algorithm registred, ask for one before removing observers")
         #


@@ -617,7 +617,7 @@ class Aidsm(object):
             Template       = None,
             String         = None,
             Script         = None):
             Template       = None,
             String         = None,
             Script         = None):

-        "Definition d'un concept de calcul"
+        "Définition d'un concept de calcul"

         Concept = "UserPostAnalysis"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept].append( repr(UserScript(
         Concept = "UserPostAnalysis"
         self.__case.register("set"+Concept, dir(), locals())
         self.__adaoObject[Concept].append( repr(UserScript(


@@ -631,7 +631,7 @@ class Aidsm(object):
     # -----------------------------------------------------------
 
     def get(self, Concept=None, noDetails=True ):
     # -----------------------------------------------------------
 
     def get(self, Concept=None, noDetails=True ):

-        "Recuperation d'une sortie du calcul"
+        "Récupération d'une sortie du calcul"

         if Concept is not None:
             try:
                 self.__case.register("get", dir(), locals(), Concept) # Break pickle in Python 2
         if Concept is not None:
             try:
                 self.__case.register("get", dir(), locals(), Concept) # Break pickle in Python 2


@@ -676,7 +676,7 @@ class Aidsm(object):
 
     # -----------------------------------------------------------
 
 
     # -----------------------------------------------------------
 

-    def get_available_variables(self):
+    def __get_available_variables(self):

         """
         Renvoie les variables potentiellement utilisables pour l'étude,
         initialement stockées comme données d'entrées ou dans les algorithmes,
         """
         Renvoie les variables potentiellement utilisables pour l'étude,
         initialement stockées comme données d'entrées ou dans les algorithmes,


@@ -700,7 +700,7 @@ class Aidsm(object):
             variables.sort()
             return variables
 
             variables.sort()
             return variables
 

-    def get_available_algorithms(self):
+    def __get_available_algorithms(self):

         """
         Renvoie la liste des algorithmes potentiellement utilisables, identifiés
         par les chaînes de caractères.
         """
         Renvoie la liste des algorithmes potentiellement utilisables, identifiés
         par les chaînes de caractères.


@@ -720,13 +720,13 @@ class Aidsm(object):
         files.sort()
         return files
 
         files.sort()
         return files
 

-    def get_algorithms_main_path(self):
+    def __get_algorithms_main_path(self):

         """
         Renvoie le chemin pour le répertoire principal contenant les algorithmes
         """
         return self.__parent
 
         """
         Renvoie le chemin pour le répertoire principal contenant les algorithmes
         """
         return self.__parent
 

-    def add_algorithms_path(self, Path=None):
+    def __add_algorithms_path(self, Path=None):

         """
         Ajoute au chemin de recherche des algorithmes un répertoire dans lequel
         se trouve un sous-répertoire "daAlgorithms"
         """
         Ajoute au chemin de recherche des algorithmes un répertoire dans lequel
         se trouve un sous-répertoire "daAlgorithms"