Salome HOME
CCAR:
[tools/eficas.git] / Extensions / parametre.py
1 #            CONFIGURATION MANAGEMENT OF EDF VERSION
2 # ======================================================================
3 # COPYRIGHT (C) 1991 - 2002  EDF R&D                  WWW.CODE-ASTER.ORG
4 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
5 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
6 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR
7 # (AT YOUR OPTION) ANY LATER VERSION.
8 #
9 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT
10 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF
11 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU
12 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.
13 #
14 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE
15 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,
16 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.
17 #
18 #
19 # ======================================================================
20 """
21     Ce module contient la classe PARAMETRE qui sert à définir
22     des objets paramètres qui sont compréhensibles et donc affichables
23     par EFICAS.
24     Ces objets sont créés à partir de la modification du fichier de commandes
25     de l'utilisateur par le parseur de fichiers Python
26 """
27
28 # import de modules Python
29 import string,types
30
31 # import de modules Eficas
32 from Noyau.N_CR import CR
33
34 class PARAMETRE :
35   """
36      Cette classe permet de créer des objets de type PARAMETRE
37      cad des affectations directes dans le jeu de commandes (ex: a=10.)
38      qui sont interprétées par le parseur de fichiers Python.
39      Les objets ainsi créés constituent des paramètres pour le jdc
40   """
41
42   nature = 'PARAMETRE'
43   idracine = 'param'
44
45   def __init__(self,nom,valeur=None):
46     # parent ne peut être qu'un objet de type JDC
47     self.valeur = self.interprete_valeur(valeur)
48     self.val=valeur
49     self.nom = nom
50     # La classe PARAMETRE n'a pas de définition : on utilise self pour
51     # complétude
52     self.definition=self
53     self.jdc = self.parent = CONTEXT.get_current_step()
54     self.niveau=self.parent.niveau
55     self.actif=1
56     self.register()
57
58   def interprete_valeur(self,val):
59     """
60     Essaie d'interpréter val (chaîne de caractères)comme :
61     - un entier
62     - un réel
63     - une chaîne de caractères
64     - une liste d'items d'un type qui précède
65     Retourne la valeur interprétée
66     """
67     if not val : return None
68     valeur = None
69     #  on vérifie si val est un entier
70     try :
71         valeur = string.atoi(val)       # on a un entier
72         return valeur
73     except :
74         pass
75     #  on vérifie si val est un réel
76     try:
77         valeur = string.atof(val)   # on a un réel
78         return valeur
79     except :
80         pass
81     # on vérifie si val est un tuple
82     try :
83         valeur = eval(val)
84     except:
85         pass
86     if valeur != None :
87         if type(valeur) == types.TupleType:
88             l_new_val = []
89             typ = None
90             for v in valeur :
91                 if not typ:
92                     typ = type(v)
93                 else:
94                     if type(v) != typ :
95                         # la liste est hétérogène --> on refuse d'interpréter
96                         #  self comme une liste
97                         # on retourne la string initiale
98                         print 'liste hétérogène ',val
99                         return val
100                 l_new_val.append(v)
101             return tuple(l_new_val)
102         else:
103             # on a réussi à évaluer val en autre chose qu'un tuple ...
104             print "on a réussi à évaluer %s en autre chose qu'un tuple ..." %val
105             print 'on trouve : ',str(valeur),' de type : ',type(valeur)
106     # on retourne val comme une string car on n'a pas su l'interpréter
107     return val
108
109   def set_valeur(self,new_valeur):
110     """
111     Remplace la valeur de self par new_valeur interprétée
112     """
113     self.valeur = self.interprete_valeur(new_valeur)
114     self.init_modif()
115
116   def init_modif(self):
117     """
118     Méthode qui déclare l'objet courant comme modifié et propage
119     cet état modifié à ses ascendants
120     """
121     self.state = 'modified'
122     if self.parent:
123       self.parent.init_modif()
124
125   def register(self):
126     """
127     Enregistre le paramètre dans la liste des étapes de son parent (JDC)
128     """
129     self.parent.register_parametre(self)
130     self.parent.register(self)
131
132   def isvalid(self,cr='non'):
133     """
134     Retourne 1 si self est valide, 0 sinon
135     Un paramètre est considéré comme valide si :
136     - il a un nom
137     - il a une valeur
138     """
139     if self.nom == '' :
140         if cr == 'oui':
141            self.cr.fatal("Pas de nom donné au paramètre ")
142         return 0
143     else:
144         if self.valeur == None :
145             if cr == 'oui' : 
146                self.cr.fatal("Le paramètre %s ne peut valoir None" % self.nom)
147             return 0
148     return 1
149
150   def isoblig(self):
151     """
152     Indique si self est obligatoire ou non : retourne toujours 0
153     """
154     return 0
155
156   def isrepetable(self):
157     """
158     Indique si self est répétable ou non : retourne toujours 1
159     """
160     return 1
161
162   def liste_mc_presents(self):
163     return []
164
165   def supprime(self):
166     """
167     Méthode qui supprime toutes les boucles de références afin que 
168     l'objet puisse être correctement détruit par le garbage collector
169     """
170     self.parent = None
171     self.jdc = None
172     self.definition=None
173
174   def active(self):
175     """
176     Rend l'etape courante active.
177     Il faut ajouter le paramètre au contexte global du JDC
178     """
179     self.actif = 1
180     try:
181         self.jdc.append_param(self)
182     except:
183         pass
184
185   def inactive(self):
186     """
187     Rend l'etape courante inactive
188     Il faut supprimer le paramètre du contexte global du JDC
189     """
190     self.actif = 0
191     self.jdc.del_param(self)
192     self.jdc.delete_concept_after_etape(self,self)
193
194   def isactif(self):
195     """
196     Booléenne qui retourne 1 si self est actif, 0 sinon
197     """
198     return self.actif
199
200   def set_attribut(self,nom_attr,new_valeur):
201     """
202     Remplace la valeur de self.nom_attr par new_valeur)
203     """
204     if hasattr(self,nom_attr):
205       setattr(self,nom_attr,new_valeur)
206       self.init_modif()
207
208   def supprime_sdprods(self):
209     """
210     Il faut supprimer le paramètre qui a été entré dans la liste des
211     paramètres du JDC
212     """
213     self.jdc.delete_param(self)
214
215   def update_context(self,d):
216     """
217     Update le dictionnaire d avec le paramètre que produit self
218     """
219     d[self.nom]=self
220
221   def __repr__(self):
222     """
223         Donne un echo de self sous la forme nom = valeur
224     """
225     return self.nom+' = '+str(self.valeur)+'\n'
226
227   def __str__(self):
228     """
229         Retourne le nom du paramètre comme représentation de self
230     """
231     return self.nom
232
233   def get_sdprods(self,nom_sd):
234      """
235          Retourne les concepts produits par la commande
236      """
237      return None
238
239   def report(self):
240     """ Génère l'objet rapport (classe CR) """
241     self.cr=CR()
242     self.isvalid(cr='oui')
243     return self.cr
244
245   def ident(self):
246     """
247     Retourne le nom interne associé à self
248     Ce nom n'est jamais vu par l'utilisateur dans EFICAS
249     """
250     return self.nom
251
252   def delete_concept(self,sd):
253     pass
254
255   def verif_condition_bloc(self):
256     """
257         Evalue les conditions de tous les blocs fils possibles
258         (en fonction du catalogue donc de la définition) de self et
259         retourne deux listes :
260         - la première contient les noms des blocs à rajouter
261         - la seconde contient les noms des blocs à supprimer
262     """
263     return [],[]
264
265   def verif_condition_regles(self,liste_presents):
266     """
267         Retourne la liste des mots-clés à rajouter pour satisfaire les règles
268         en fonction de la liste des mots-clés présents
269     """
270     return []
271
272   def verif_existence_sd(self):
273      pass
274
275
276
277