Salome HOME
CCAR : mise a jour avec la version 7.3.23 du Noyau superviseur Aster
[tools/eficas.git] / Noyau / N_PROC.py
1 #@ MODIF N_PROC Noyau  DATE 14/09/2004   AUTEUR MCOURTOI M.COURTOIS 
2 # -*- coding: iso-8859-1 -*-
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
24 """ 
25     Ce module contient la classe de definition PROC
26     qui permet de spécifier les caractéristiques d'une procédure
27 """
28
29 import types,string,traceback
30
31 import N_ENTITE
32 import N_PROC_ETAPE
33
34 class PROC(N_ENTITE.ENTITE):
35    """
36     Classe pour definir un opérateur
37
38     Cette classe a deux attributs de classe 
39
40     - class_instance qui indique la classe qui devra etre utilisée 
41             pour créer l'objet qui servira à controler la conformité d'un 
42             opérateur avec sa définition
43
44     - label qui indique la nature de l'objet de définition (ici, PROC)
45
46
47     et les attributs d'instance suivants :
48
49     - nom   : son nom
50
51     - op   : le numéro d'opérateur
52
53     - reentrant : vaut 'n' ou 'o'. Indique si l'opérateur est réentrant ou pas. Un opérateur
54                         réentrant peut modifier un concept d'entrée et le produire comme concept de sortie
55
56     - repetable : vaut 'n' ou 'o'. Indique si l'opérateur est répetable ou pas. Un opérateur
57                         non répétable ne doit apparaitre qu'une fois dans une exécution. C'est du ressort
58                         de l'objet gérant le contexte d'exécution de vérifier cette contrainte.
59
60     - fr   : commentaire associé en francais
61
62     - ang : commentaire associé en anglais
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=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 operateur sauf si == None
102       self.op_init=op_init
103       self.entites=args
104       current_cata=CONTEXT.get_current_cata()
105       if niveau == None:
106          self.niveau=None
107          current_cata.enregistre(self)
108       else:
109          self.niveau=current_cata.get_niveau(niveau)
110          self.niveau.enregistre(self)
111       self.UIinfo=UIinfo
112       self.affecter_parente()
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       if type(self.regles) != types.TupleType :
139         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
140       if type(self.fr) != types.StringType :
141         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
142       if self.reentrant not in ('o','n','f'):
143         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
144       if type(self.docu) != types.StringType :
145         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
146       if type(self.nom) != types.StringType :
147         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
148       if type(self.op) != types.IntType :
149         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
150       self.verif_cata_regles()
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
158
159