Noyau/N_MACRO.py

   1 # coding=utf-8
   2 # Copyright (C) 2007-2013   EDF R&D
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19
  20
  21 """
  22     Ce module contient la classe de definition MACRO
  23     qui permet de spécifier les caractéristiques d'une macro-commande
  24 """
  25
  26 from __future__ import absolute_import
  27 import types
  28 import traceback
  29
  30 from . import N_ENTITE
  31 from . import N_MACRO_ETAPE
  32 from . import nommage
  33
  34
  35 class MACRO(N_ENTITE.ENTITE):
  36
  37     """
  38      Classe pour definir une macro-commande
  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              macro-commande avec sa définition
  45
  46      - label qui indique la nature de l'objet de définition (ici, MACRO)
  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      - docu : clé de documentation associée
  69
  70      - regles : liste des règles associées
  71
  72      - op_init : cet attribut vaut None ou une fonction. Si cet attribut ne vaut pas None, cette
  73                        fonction est exécutée lors des phases d'initialisation de l'étape associée.
  74
  75      - niveau : indique le niveau dans lequel est rangé l'opérateur. Les opérateurs peuvent etre
  76                       rangés par niveau. Ils apparaissent alors exclusivement dans leur niveau de rangement.
  77                       Si niveau vaut None, l'opérateur est rangé au niveau global.
  78
  79      - entites : dictionnaire dans lequel sont stockés les sous entités de l'opérateur. Il s'agit
  80                        des entités de définition pour les mots-clés : FACT, BLOC, SIMP. Cet attribut
  81                        est initialisé avec args, c'est à dire les arguments d'appel restants.
  82
  83
  84     """
  85     class_instance = N_MACRO_ETAPE.MACRO_ETAPE
  86     label = 'MACRO'
  87     nommage = nommage
  88
  89     def __init__(
  90         self, nom, op, sd_prod=None, reentrant='n', repetable='o', fr="",ang="",
  91             docu="", regles=(), op_init=None, niveau = None, fichier_ini=0, UIinfo=None, **args):
  92         """
  93            Méthode d'initialisation de l'objet MACRO. Les arguments sont utilisés pour initialiser
  94            les attributs de meme nom
  95         """
  96         # XXX fichier_ini n'est pas utilisé pour l'instant
  97         self.nom = nom
  98         # op est obligatoire et permet de spécifier la procédure de construction de la macro
  99         # - Si op est un entier la construction de la macro est réalisée par une subroutine fortran opsxxx ou
 100         # xxx est donné par la valeur absolue de op. L'execution est egalement effectuée via cette subroutine.
 101         # - Si op est une fonction Python, la construction de la macro est effectuée par l'appel à cette fonction
 102         # Suivant le cas on garde l info dans self.op ou dans self.proc
 103         if type(op) == int:
 104             self.proc = None
 105             self.op = op
 106         else:
 107             self.op = None
 108             self.proc = op
 109
 110         self.sd_prod = sd_prod
 111         self.reentrant = reentrant
 112         self.fr = fr
 113         self.ang=ang
 114         self.repetable = repetable
 115         self.docu = docu
 116         if type(regles) == tuple:
 117             self.regles = regles
 118         else:
 119             self.regles = (regles,)
 120         self.fichier_ini = fichier_ini
 121         # Attribut op_init : Fonction a appeler a la construction de l
 122         # operateur sauf si == None
 123         self.op_init = op_init
 124         self.entites = args
 125         current_cata = CONTEXT.get_current_cata()
 126         if niveau == None:
 127             self.niveau = None
 128             current_cata.enregistre(self)
 129         else:
 130             self.niveau = current_cata.get_niveau(niveau)
 131             self.niveau.enregistre(self)
 132         self.UIinfo = UIinfo
 133         self.affecter_parente()
 134         self.check_definition(self.nom)
 135
 136     def __call__(self, reuse=None, **args):
 137         """
 138             Construit l'objet MACRO_ETAPE a partir de sa definition (self),
 139             puis demande la construction de ses sous-objets et du concept produit.
 140         """
 141         nomsd = self.nommage.GetNomConceptResultat(self.nom)
 142         etape = self.class_instance(oper=self, reuse=reuse, args=args)
 143         etape.McBuild()
 144         return etape.Build_sd(nomsd)
 145
 146     def make_objet(self, mc_list='oui'):
 147         """
 148              Cette méthode crée l'objet MACRO_ETAPE dont la définition est self sans
 149              créer sa sdprod.
 150              Normalement l'étape est enregistrée auprès de son parent.
 151              Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
 152              des objets MCxxx.
 153         """
 154         etape = self.class_instance(oper=self, reuse=None, args={})
 155         if mc_list == 'oui':
 156             etape.McBuild()
 157         return etape
 158
 159     def verif_cata(self):
 160         """
 161             Méthode de vérification des attributs de définition
 162         """
 163         self.check_op(valmax=0)
 164         self.check_proc()
 165         self.check_regles()
 166         self.check_fr()
 167         self.check_docu()
 168         self.check_nom()
 169         self.check_reentrant()
 170         self.verif_cata_regles()
 171
 172     def supprime(self):
 173         """
 174             Méthode pour supprimer les références arrières susceptibles de provoquer
 175             des cycles de références
 176         """
 177         self.niveau = None