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