Salome HOME
CCAR: ajout des fichiers macros
[tools/eficas.git] / Noyau / N_OPER.py
1 # -*- coding: utf-8 -*-
2 #@ MODIF N_OPER 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 OPER
24     qui permet de spécifier les caractéristiques d'un opérateur
25 """
26
27 import types,string,traceback
28
29 import N_ENTITE
30 import N_ETAPE
31 import nommage
32
33 class OPER(N_ENTITE.ENTITE):
34    """
35     Classe pour definir un opérateur
36
37     Cette classe a trois 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, OPER)
44
45     - nommage qui est un module Python qui fournit la fonctionnalité de nommage
46
47     et les attributs d'instance suivants :
48
49     - nom   : son nom
50
51     - op   : le numéro d'opérateur
52
53     - sd_prod : le type de concept produit. C'est une classe ou une fonction qui retourne
54                       une classe
55
56     - reentrant : vaut 'n' ou 'o'. Indique si l'opérateur est réentrant ou pas. Un opérateur
57                         réentrant peut modifier un concept d'entrée et le produire comme concept de sortie
58
59     - repetable : vaut 'n' ou 'o'. Indique si l'opérateur est répetable ou pas. Un opérateur
60                         non répétable ne doit apparaitre qu'une fois dans une exécution. C'est du ressort
61                         de l'objet gérant le contexte d'exécution de vérifier cette contrainte.
62
63     - fr   : commentaire associé en francais
64
65     - ang : commentaire associé en anglais
66
67     - docu : clé de documentation associée
68
69     - regles : liste des règles associées
70
71     - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
72                       fonction est exécutée lors des phases d'initialisation de l'étape associée.
73
74     - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
75                      rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
76                      Si niveau vaut None, l'opérateur est rangé au niveau global.
77
78     - entites : dictionnaire dans lequel sont stockés les sous entités de l'opérateur. Il s'agit
79                       des entités de définition pour les mots-clés : FACT, BLOC, SIMP. Cet attribut
80                       est initialisé avec args, c'est à dire les arguments d'appel restants.
81
82
83    """
84    class_instance = N_ETAPE.ETAPE
85    label = 'OPER'
86    nommage = nommage
87
88    def __init__(self,nom,op,sd_prod,reentrant='n',repetable='o',fr="",ang="",
89                 docu="",regles=(),op_init=None,niveau = None,UIinfo=None,**args):
90       """
91          Méthode d'initialisation de l'objet OPER. Les arguments sont utilisés pour initialiser
92          les attributs de meme nom
93       """
94       self.nom=nom
95       self.op=op
96       self.sd_prod=sd_prod
97       self.reentrant=reentrant
98       self.fr=fr
99       self.ang=ang
100       self.repetable = repetable
101       self.docu=docu
102       if type(regles)== types.TupleType:
103           self.regles=regles
104       else:
105           self.regles=(regles,)
106       # Attribut op_init : Fonction a appeler a la construction de l operateur sauf si == None
107       self.op_init=op_init
108       self.entites=args
109       current_cata=CONTEXT.get_current_cata()
110       if niveau == None:
111          self.niveau=None
112          current_cata.enregistre(self)
113       else:
114          self.niveau=current_cata.get_niveau(niveau)
115          self.niveau.enregistre(self)
116       self.UIinfo=UIinfo
117       self.affecter_parente()
118
119    def __call__(self,reuse=None,**args):
120       """
121           Construit l'objet ETAPE a partir de sa definition (self),
122           puis demande la construction de ses sous-objets et du concept produit.
123       """
124       nomsd=self.nommage.GetNomConceptResultat(self.nom)
125       etape= self.class_instance(oper=self,reuse=reuse,args=args)
126       etape.McBuild()
127       return etape.Build_sd(nomsd)
128
129    def make_objet(self,mc_list='oui'):
130       """ 
131            Cette méthode crée l'objet ETAPE dont la définition est self sans
132             l'enregistrer ni créer sa sdprod.
133            Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction 
134            des objets MCxxx.
135       """
136       etape= self.class_instance(oper=self,reuse=None,args={})
137       if mc_list == 'oui':etape.McBuild()
138       return etape
139
140    def verif_cata(self):
141       """
142           Méthode de vérification des attributs de définition
143       """
144       if type(self.regles) != types.TupleType :
145         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
146       if type(self.fr) != types.StringType :
147         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
148       if self.reentrant not in ('o','n','f'):
149         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
150       if type(self.docu) != types.StringType :
151         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
152       if type(self.nom) != types.StringType :
153         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
154       if type(self.op) != types.IntType :
155         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
156       self.verif_cata_regles()
157
158    def supprime(self):
159       """
160           Méthode pour supprimer les références arrières susceptibles de provoquer
161           des cycles de références
162       """
163       self.niveau=None
164
165