Noyau/N_OPER.py

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