Salome HOME
*** empty log message ***
[tools/eficas.git] / Noyau / N_PROC.py
1 # -*- coding: utf-8 -*-
2 #@ MODIF N_PROC Noyau  DATE 09/10/2002   AUTEUR DURAND C.DURAND 
3 #            CONFIGURATION MANAGEMENT OF EDF VERSION
4 # ======================================================================
5 # COPYRIGHT (C) 1991 - 2002  EDF R&D                  WWW.CODE-ASTER.ORG
6 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
7 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
8 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR   
9 # (AT YOUR OPTION) ANY LATER VERSION.                                 
10 #
11 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT 
12 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF          
13 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU    
14 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.                            
15 #
16 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE   
17 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,       
18 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.      
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
32 class PROC(N_ENTITE.ENTITE):
33    """
34     Classe pour definir un opérateur
35
36     Cette classe a deux attributs de classe 
37
38     - class_instance qui indique la classe qui devra etre utilisée 
39             pour créer l'objet qui servira à controler la conformité d'un 
40             opérateur avec sa définition
41
42     - label qui indique la nature de l'objet de définition (ici, PROC)
43
44
45     et les attributs d'instance suivants :
46
47     - nom   : son nom
48
49     - op   : le numéro d'opérateur
50
51     - reentrant : vaut 'n' ou 'o'. Indique si l'opérateur est réentrant ou pas. Un opérateur
52                         réentrant peut modifier un concept d'entrée et le produire comme concept de sortie
53
54     - repetable : vaut 'n' ou 'o'. Indique si l'opérateur est répetable ou pas. Un opérateur
55                         non répétable ne doit apparaitre qu'une fois dans une exécution. C'est du ressort
56                         de l'objet gérant le contexte d'exécution de vérifier cette contrainte.
57
58     - fr   : commentaire associé en francais
59
60     - ang : commentaire associé en anglais
61
62     - docu : clé de documentation associée
63
64     - regles : liste des règles associées
65
66     - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
67                       fonction est exécutée lors des phases d'initialisation de l'étape associée.
68
69     - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
70                      rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
71                      Si niveau vaut None, l'opérateur est rangé au niveau global.
72
73     - entites : dictionnaire dans lequel sont stockés les sous entités de l'opérateur. Il s'agit
74                       des entités de définition pour les mots-clés : FACT, BLOC, SIMP. Cet attribut
75                       est initialisé avec args, c'est à dire les arguments d'appel restants.
76
77
78    """
79    class_instance = N_PROC_ETAPE.PROC_ETAPE
80    label = 'PROC'
81
82    def __init__(self,nom,op,reentrant='n',repetable='o',fr="",ang="",
83                 docu="",regles=(),op_init=None,niveau = None,UIinfo=None,**args):
84       """
85          Méthode d'initialisation de l'objet PROC. Les arguments sont utilisés pour initialiser
86          les attributs de meme nom
87       """
88       self.nom=nom
89       self.op=op
90       self.reentrant=reentrant
91       self.repetable = repetable
92       self.fr=fr
93       self.ang=ang
94       self.docu=docu
95       if type(regles)== types.TupleType:
96           self.regles=regles
97       else:
98           self.regles=(regles,)
99       # Attribut op_init : Fonction a appeler a la construction de l operateur sauf si == None
100       self.op_init=op_init
101       self.entites=args
102       current_cata=CONTEXT.get_current_cata()
103       if niveau == None:
104          self.niveau=None
105          current_cata.enregistre(self)
106       else:
107          self.niveau=current_cata.get_niveau(niveau)
108          self.niveau.enregistre(self)
109       self.UIinfo=UIinfo
110       self.affecter_parente()
111
112    def __call__(self,**args):
113       """
114           Construit l'objet PROC_ETAPE a partir de sa definition (self),
115           puis demande la construction de ses sous-objets et du concept produit.
116       """
117       etape= self.class_instance(oper=self,args=args)
118       etape.McBuild()
119       return etape.Build_sd()
120
121    def make_objet(self,mc_list='oui'):
122       """
123            Cette méthode crée l'objet PROC_ETAPE dont la définition est self sans
124             l'enregistrer ni créer sa sdprod.
125            Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
126            des objets MCxxx.
127       """
128       etape= self.class_instance(oper=self,args={})
129       if mc_list == 'oui':etape.McBuild()
130       return etape
131
132    def verif_cata(self):
133       """
134           Méthode de vérification des attributs de définition
135       """
136       if type(self.regles) != types.TupleType :
137         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
138       if type(self.fr) != types.StringType :
139         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
140       if self.reentrant not in ('o','n','f'):
141         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
142       if type(self.docu) != types.StringType :
143         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
144       if type(self.nom) != types.StringType :
145         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
146       if type(self.op) != types.IntType :
147         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
148       self.verif_cata_regles()
149
150    def supprime(self):
151       """
152           Méthode pour supprimer les références arrières susceptibles de provoquer
153           des cycles de références
154       """
155       self.niveau=None
156
157