Salome HOME
legere difference ds VARIABLES_TO_BE...
[tools/eficas.git] / Noyau / N_MCLIST.py
1 # coding=utf-8
2 # Copyright (C) 2007-2013   EDF R&D
3 #
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License.
8 #
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 # Lesser General Public License for more details.
13 #
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 #
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19
20
21 """
22     Ce module contient la classe MCList qui sert à controler la valeur
23     d'une liste de mots-clés facteur par rapport à sa définition portée par un objet
24     de type ENTITE
25 """
26
27 from __future__ import absolute_import
28 try :
29    from future import standard_library
30    standard_library.install_aliases()
31 except : 
32    pass
33 from copy import copy
34 import types
35
36 try:
37    from UserList import UserList
38 except ImportError:
39    from collections import UserList
40
41
42
43
44 class MCList(UserList):
45
46     """ Liste semblable a la liste Python
47         mais avec quelques methodes en plus
48         = liste de MCFACT
49     """
50     nature = 'MCList'
51
52     def init(self, nom, parent):
53         self.definition = None
54         self.nom = nom
55         self.parent = parent
56         if parent:
57             self.jdc = self.parent.jdc
58             self.niveau = self.parent.niveau
59             self.etape = self.parent.etape
60         else:
61             # Le mot cle a été créé sans parent
62             self.jdc = None
63             self.niveau = None
64             self.etape = None
65
66     def get_valeur(self):
67         """
68            Retourne la "valeur" d'un objet MCList. Sert à construire
69            un contexte d'évaluation pour une expression Python.
70            On retourne l'objet lui-meme.
71         """
72         return self
73
74     def get_val(self):
75         """
76             Une autre méthode qui retourne une "autre" valeur d'une MCList
77             Elle est utilisée par la méthode get_mocle
78         """
79         return self
80
81     def supprime(self):
82         """
83            Méthode qui supprime toutes les références arrières afin que l'objet puisse
84            etre correctement détruit par le garbage collector
85         """
86         self.parent = None
87         self.etape = None
88         self.jdc = None
89         self.niveau = None
90         for child in self.data:
91             child.supprime()
92
93     def get_child(self, name,restreint='non'):
94         """
95             Retourne le fils de nom name s'il est contenu dans self
96             Par défaut retourne le fils du premier de la liste
97         """
98         obj = self.data[0]
99         # Phase 1 : on cherche dans les fils directs de obj
100         for child in obj.mc_liste:
101             if child.nom == name:
102                 return child
103         # Phase 2 : on cherche dans les blocs de self
104         for child in obj.mc_liste:
105             if child.isBLOC():
106                 resu = child.get_child(name)
107                 if resu != None:
108                     return resu
109         # Phase 3 : on cherche dans les entites possibles pour les défauts
110         for k, v in list(obj.definition.entites.items()):
111             # if k == name: return v.defaut
112             if k == name:
113                 if v.defaut != None:
114                     return v(None, k, None)
115         # si on passe ici, c'est que l'on demande un fils qui n'est pas possible --> erreur
116         # print "Erreur : %s ne peut etre un descendant de %s" %(name,self.nom)
117         return None
118
119     def isBLOC(self):
120         """
121              Indique si l'objet est de type BLOC
122         """
123         return 0
124
125     def accept(self, visitor):
126         """
127            Cette methode permet de parcourir l'arborescence des objets
128            en utilisant le pattern VISITEUR
129         """
130         visitor.visitMCList(self)
131
132     def get_sd_utilisees(self):
133         """
134           Retourne la liste des concepts qui sont utilisés à l'intérieur de self
135           ( comme valorisation d'un MCS)
136         """
137         l = []
138         for child in self.data:
139             l.extend(child.get_sd_utilisees())
140         return l
141
142     def get_sd_mcs_utilisees(self):
143         """
144             Retourne la ou les SD utilisée par self sous forme d'un dictionnaire :
145               - Si aucune sd n'est utilisée, le dictionnaire est vide.
146               - Sinon, les clés du dictionnaire sont les mots-clés derrière lesquels on
147                 trouve des sd ; la valeur est la liste des sd attenante.
148
149                 Exemple ::
150
151                   { 'VALE_F': [ <Cata.cata.fonction_sdaster instance at 0x9419854>,
152                                 <Cata.cata.fonction_sdaster instance at 0x941a204> ],
153                     'MODELE': [<Cata.cata.modele instance at 0x941550c>] }
154         """
155         dico = {}
156         for child in self.data:
157             daux = child.get_sd_mcs_utilisees()
158             for cle in daux:
159                 dico[cle] = dico.get(cle, [])
160                 dico[cle].extend(daux[cle])
161         return dico
162
163     def get_mcs_with_co(self, co):
164         """
165            Cette methode retourne l'objet MCSIMP fils de self
166            qui a le concept co comme valeur.
167            En principe, elle ne doit etre utilisee que pour les concepts
168            instances de la classe CO
169         """
170         l = []
171         for child in self.data:
172             l.extend(child.get_mcs_with_co(co))
173         return l
174
175     def get_all_co(self):
176         """
177            Cette methode retourne tous les concepts instances de CO
178         """
179         l = []
180         for child in self.data:
181             l.extend(child.get_all_co())
182         return l
183
184     def copy(self):
185         """
186           Réalise la copie d'une MCList
187         """
188         liste = self.data[0].definition.list_instance()
189         # FR -->Il faut spécifier un parent pour la méthode init qui attend 2
190         # arguments ...
191         liste.init(self.nom, self.parent)
192         for objet in self:
193             new_obj = objet.copy()
194             # Pour etre coherent avec le constructeur de mots cles facteurs N_FACT.__call__
195             # dans lequel le parent de l'element d'une MCList est le parent de
196             # la MCList
197             new_obj.reparent(self.parent)
198             liste.append(new_obj)
199         return liste
200
201     def reparent(self, parent):
202         """
203            Cette methode sert a reinitialiser la parente de l'objet
204         """
205         self.parent = parent
206         self.jdc = parent.jdc
207         self.etape = parent.etape
208         for mcfact in self.data:
209             mcfact.reparent(parent)
210
211     def get_etape(self):
212         """
213            Retourne l'étape à laquelle appartient self
214            Un objet de la catégorie etape doit retourner self pour indiquer que
215            l'étape a été trouvée
216            XXX double emploi avec self.etape ???
217         """
218         if self.parent == None:
219             return None
220         return self.parent.get_etape()
221
222     def __getitem__(self, key):
223         """
224            Dans le cas d un mot cle facteur de longueur 1 on simule un scalaire
225         """
226         if type(key) != int and len(self) == 1:
227             return self.data[0].get_mocle(key)
228         else:
229             return self.data[key]
230
231     def List_F(self):
232         """
233            Retourne une liste de dictionnaires (eventuellement singleton) qui peut etre
234            passe directement derriere un mot-cle facteur (pour les macros).
235         """
236         dresu = []
237         for mcf in self:
238             dico = mcf.cree_dict_valeurs(mcf.mc_liste)
239             for i in list(dico.keys()):
240                 if dico[i] == None:
241                     del dico[i]
242             dresu.append(dico)
243         return dresu