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