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