Noyau/N_MACRO.py

   1 # -*- coding: utf-8 -*-
   2 #@ MODIF N_MACRO 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 MACRO
  24     qui permet de spécifier les caractéristiques d'une macro-commande
  25 """
  26
  27 import types,string,traceback
  28
  29 import N_ENTITE
  30 import N_MACRO_ETAPE
  31 import nommage
  32
  33 class MACRO(N_ENTITE.ENTITE):
  34    """
  35     Classe pour definir une macro-commande
  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             macro-commande avec sa définition
  42
  43     - label qui indique la nature de l'objet de définition (ici, MACRO)
  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_MACRO_ETAPE.MACRO_ETAPE
  85    label = 'MACRO'
  86    nommage = nommage
  87
  88    def __init__(self,nom,op,sd_prod=None,reentrant='n',repetable='o',fr="",ang="",
  89                 docu="",regles=(),op_init=None,niveau = None,fichier_ini=0,UIinfo=None,**args):
  90       """
  91          Méthode d'initialisation de l'objet MACRO. Les arguments sont utilisés pour initialiser
  92          les attributs de meme nom
  93       """
  94       # XXX fichier_ini n'est pas utilisé pour l'instant
  95       self.nom=nom
  96       # op est obligatoire et permet de spécifier la procédure de construction de la macro
  97       # - Si op est un entier la construction de la macro est réalisée par une subroutine fortran opsxxx ou
  98       # xxx est donné par la valeur absolue de op. L'execution est egalement effectuée via cette subroutine.
  99       # - Si op est une fonction Python, la construction de la macro est effectuée par l'appel à cette fonction
 100       # Suivant le cas on garde l info dans self.op ou dans self.proc
 101       if type(op) == types.IntType:
 102         self.proc=None
 103         self.op=op
 104       else:
 105         self.op=None
 106         self.proc=op
 107
 108       self.sd_prod=sd_prod
 109       self.reentrant=reentrant
 110       self.fr=fr
 111       self.ang=ang
 112       self.repetable = repetable
 113       self.docu=docu
 114       if type(regles)== types.TupleType:
 115           self.regles=regles
 116       else:
 117           self.regles=(regles,)
 118       self.fichier_ini = fichier_ini
 119       # Attribut op_init : Fonction a appeler a la construction de l operateur sauf si == None
 120       self.op_init=op_init
 121       self.entites=args
 122       current_cata=CONTEXT.get_current_cata()
 123       if niveau == None:
 124          self.niveau=None
 125          current_cata.enregistre(self)
 126       else:
 127          self.niveau=current_cata.get_niveau(niveau)
 128          self.niveau.enregistre(self)
 129       self.UIinfo=UIinfo
 130       self.affecter_parente()
 131
 132    def __call__(self,reuse=None,**args):
 133       """
 134           Construit l'objet MACRO_ETAPE a partir de sa definition (self),
 135           puis demande la construction de ses sous-objets et du concept produit.
 136       """
 137       nomsd=self.nommage.GetNomConceptResultat(self.nom)
 138       etape= self.class_instance(oper=self,reuse=reuse,args=args)
 139       etape.McBuild()
 140       return etape.Build_sd(nomsd)
 141
 142    def make_objet(self,mc_list='oui'):
 143       """
 144            Cette méthode crée l'objet MACRO_ETAPE dont la définition est self sans
 145            créer sa sdprod.
 146            Normalement l'étape est enregistrée auprès de son parent.
 147            Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
 148            des objets MCxxx.
 149       """
 150       etape= self.class_instance(oper=self,reuse=None,args={})
 151       if mc_list == 'oui':etape.McBuild()
 152       return etape
 153
 154    def verif_cata(self):
 155       """
 156           Méthode de vérification des attributs de définition
 157       """
 158       if self.op is not None and (type(self.op) != types.IntType or self.op > 0) :
 159         self.cr.fatal("L'attribut 'op' doit etre un entier signé : %s" %`self.op`)
 160       if self.proc is not None and type(self.proc) != types.FunctionType:
 161         self.cr.fatal("L'attribut op doit etre une fonction Python : %s" % `self.proc`)
 162       if type(self.regles) != types.TupleType :
 163         self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
 164       if type(self.fr) != types.StringType :
 165         self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
 166       if type(self.docu) != types.StringType :
 167         self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu` )
 168       if type(self.nom) != types.StringType :
 169         self.cr.fatal("L'attribut 'nom' doit etre une chaine de caractères : %s" %`self.nom`)
 170       if self.reentrant not in ('o','n','f'):
 171         self.cr.fatal("L'attribut 'reentrant' doit valoir 'o','n' ou 'f' : %s" %`self.reentrant`)
 172       self.verif_cata_regles()
 173
 174    def supprime(self):
 175       """
 176           Méthode pour supprimer les références arrières susceptibles de provoquer
 177           des cycles de références
 178       """
 179       self.niveau=None
 180
 181