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