Salome HOME
Modif V6_4_°
[tools/eficas.git] / Noyau / N_PROC.py
1 #@ MODIF N_PROC Noyau  DATE 30/08/2011   AUTEUR COURTOIS M.COURTOIS 
2 # -*- coding: iso-8859-1 -*-
3 # RESPONSABLE COURTOIS M.COURTOIS
4 #            CONFIGURATION MANAGEMENT OF EDF VERSION
5 # ======================================================================
6 # COPYRIGHT (C) 1991 - 2011  EDF R&D                  WWW.CODE-ASTER.ORG
7 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
8 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
9 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR
10 # (AT YOUR OPTION) ANY LATER VERSION.
11 #
12 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT
13 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF
14 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU
15 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.
16 #
17 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE
18 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,
19 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.
20 #
21 #
22 # ======================================================================
23
24
25 """
26     Ce module contient la classe de definition PROC
27     qui permet de spécifier les caractéristiques d'une procédure
28 """
29
30 import types,string,traceback
31
32 import N_ENTITE
33 import N_PROC_ETAPE
34
35 class PROC(N_ENTITE.ENTITE):
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     - ang : commentaire associé en anglais
64
65     - docu : clé de documentation associée
66
67     - regles : liste des règles associées
68
69     - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
70                       fonction est exécutée lors des phases d'initialisation de l'étape associée.
71
72     - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
73                      rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
74                      Si niveau vaut None, l'opérateur est rangé au niveau global.
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,reentrant='n',repetable='o',fr="",ang="",
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.fr=fr
96       self.ang=ang
97       self.docu=docu
98       if type(regles)== types.TupleType:
99           self.regles=regles
100       else:
101           self.regles=(regles,)
102       # Attribut op_init : Fonction a appeler a la construction de l 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':etape.McBuild()
134       return etape
135
136    def verif_cata(self):
137       """
138           Méthode de vérification des attributs de définition
139       """
140       if type(self.regles) != types.TupleType :
141         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
142       if type(self.fr) != types.StringType :
143         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
144       if self.reentrant not in ('o','n','f'):
145         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
146       if type(self.docu) != types.StringType :
147         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
148       if type(self.nom) != types.StringType :
149         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
150       if type(self.op) != types.IntType :
151         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
152       self.verif_cata_regles()
153
154    def supprime(self):
155       """
156           Méthode pour supprimer les références arrières susceptibles de provoquer
157           des cycles de références
158       """
159       self.niveau=None
160
161