Salome HOME
bugs + translator
[tools/eficas.git] / Noyau / N_OPER.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 de definition OPER
23     qui permet de spécifier les caractéristiques d'un opérateur
24 """
25
26 import types
27 import string
28 import traceback
29
30 import N_ENTITE
31 import N_ETAPE
32 import nommage
33 from strfunc import ufmt
34
35
36 class OPER(N_ENTITE.ENTITE):
37
38     """
39      Classe pour definir un opérateur
40
41      Cette classe a trois attributs de classe
42
43      - class_instance qui indique la classe qui devra etre utilisée
44              pour créer l'objet qui servira à controler la conformité d'un
45              opérateur avec sa définition
46
47      - label qui indique la nature de l'objet de définition (ici, OPER)
48
49      - nommage qui est un module Python qui fournit la fonctionnalité de nommage
50
51      et les attributs d'instance suivants :
52
53      - nom   : son nom
54
55      - op   : le numéro d'opérateur
56
57      - sd_prod : le type de concept produit. C'est une classe ou une fonction qui retourne
58                        une classe
59
60      - reentrant : vaut 'n' ou 'o'. Indique si l'opérateur est réentrant ou pas. Un opérateur
61                          réentrant peut modifier un concept d'entrée et le produire comme concept de sortie
62
63      - repetable : vaut 'n' ou 'o'. Indique si l'opérateur est répetable ou pas. Un opérateur
64                          non répétable ne doit apparaitre qu'une fois dans une exécution. C'est du ressort
65                          de l'objet gérant le contexte d'exécution de vérifier cette contrainte.
66
67      - fr   : commentaire associé en francais
68
69      - docu : clé de documentation associée
70
71      - regles : liste des règles associées
72
73      - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
74                        fonction est exécutée lors des phases d'initialisation de l'étape associée.
75
76      - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
77                       rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
78                       Si niveau vaut None, l'opérateur est rangé au niveau global.
79
80      - entites : dictionnaire dans lequel sont stockés les sous entités de l'opérateur. Il s'agit
81                        des entités de définition pour les mots-clés : FACT, BLOC, SIMP. Cet attribut
82                        est initialisé avec args, c'est à dire les arguments d'appel restants.
83
84
85     """
86     class_instance = N_ETAPE.ETAPE
87     label = 'OPER'
88     nommage = nommage
89
90     def __init__(self, nom, op, sd_prod, reentrant='n', repetable='o', fr="",ang="",
91                  docu="", regles=(), op_init=None, niveau = None, UIinfo=None, **args):
92         """
93            Méthode d'initialisation de l'objet OPER. Les arguments sont utilisés pour initialiser
94            les attributs de meme nom
95         """
96         self.nom = nom
97         self.op = op
98         self.sd_prod = sd_prod
99         self.reentrant = reentrant
100         self.fr = fr
101         self.ang = ang
102         self.repetable = repetable
103         self.docu = docu
104         if type(regles) == types.TupleType:
105             self.regles = regles
106         else:
107             self.regles = (regles,)
108         # Attribut op_init : Fonction a appeler a la construction de l
109         # operateur sauf si == None
110         self.op_init = op_init
111         self.entites = args
112         current_cata = CONTEXT.get_current_cata()
113         if niveau == None:
114             self.niveau = None
115             current_cata.enregistre(self)
116         else:
117             self.niveau = current_cata.get_niveau(niveau)
118             self.niveau.enregistre(self)
119         self.UIinfo = UIinfo
120         self.affecter_parente()
121         self.check_definition(self.nom)
122
123     def __call__(self, reuse=None, **args):
124         """
125             Construit l'objet ETAPE a partir de sa definition (self),
126             puis demande la construction de ses sous-objets et du concept produit.
127         """
128         nomsd = self.nommage.GetNomConceptResultat(self.nom)
129         etape = self.class_instance(oper=self, reuse=reuse, args=args)
130         etape.McBuild()
131         return etape.Build_sd(nomsd)
132
133     def make_objet(self, mc_list='oui'):
134         """
135              Cette méthode crée l'objet ETAPE dont la définition est self sans
136               l'enregistrer ni créer sa sdprod.
137              Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
138              des objets MCxxx.
139         """
140         etape = self.class_instance(oper=self, reuse=None, args={})
141         if mc_list == 'oui':
142             etape.McBuild()
143         return etape
144
145     def verif_cata(self):
146         """
147             Méthode de vérification des attributs de définition
148         """
149         self.check_regles()
150         self.check_fr()
151         self.check_reentrant()
152         self.check_docu()
153         self.check_nom()
154         self.check_op(valmin=0)
155         self.verif_cata_regles()
156
157     def supprime(self):
158         """
159             Méthode pour supprimer les références arrières susceptibles de provoquer
160             des cycles de références
161         """
162         self.niveau = None