Noyau/N_OPER.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 OPER
  23     qui permet de spécifier les caractéristiques d'un opérateur
  24 """
  25
  26 from __future__ import absolute_import
  27 import types
  28 import traceback
  29
  30 from . import N_ENTITE
  31 from . import N_ETAPE
  32 from . import nommage
  33
  34
  35 class OPER(N_ENTITE.ENTITE):
  36
  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      - 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_ETAPE.ETAPE
  86     label = 'OPER'
  87     nommage = nommage
  88
  89     def __init__(self, nom, op, sd_prod, reentrant='n', repetable='o', fr="",ang="",
  90                  docu="", regles=(), op_init=None, niveau = None, UIinfo=None, **args):
  91         """
  92            Méthode d'initialisation de l'objet OPER. Les arguments sont utilisés pour initialiser
  93            les attributs de meme nom
  94         """
  95         self.nom = nom
  96         self.op = op
  97         self.sd_prod = sd_prod
  98         self.reentrant = reentrant
  99         self.fr = fr
 100         self.ang = ang
 101         self.repetable = repetable
 102         self.docu = docu
 103         if type(regles) == tuple:
 104             self.regles = regles
 105         else:
 106             self.regles = (regles,)
 107         # Attribut op_init : Fonction a appeler a la construction de l
 108         # operateur sauf si == None
 109         self.op_init = op_init
 110         self.entites = args
 111         current_cata = CONTEXT.get_current_cata()
 112         if niveau == None:
 113             self.niveau = None
 114             current_cata.enregistre(self)
 115         else:
 116             self.niveau = current_cata.get_niveau(niveau)
 117             self.niveau.enregistre(self)
 118         self.UIinfo = UIinfo
 119         self.affecter_parente()
 120         self.check_definition(self.nom)
 121
 122     def __call__(self, reuse=None, **args):
 123         """
 124             Construit l'objet ETAPE a partir de sa definition (self),
 125             puis demande la construction de ses sous-objets et du concept produit.
 126         """
 127         nomsd = self.nommage.GetNomConceptResultat(self.nom)
 128         etape = self.class_instance(oper=self, reuse=reuse, args=args)
 129         etape.McBuild()
 130         return etape.Build_sd(nomsd)
 131
 132     def make_objet(self, mc_list='oui'):
 133         """
 134              Cette méthode crée l'objet ETAPE dont la définition est self sans
 135               l'enregistrer ni créer sa sdprod.
 136              Si l'argument mc_list vaut 'oui', elle déclenche en plus la construction
 137              des objets MCxxx.
 138         """
 139         etape = self.class_instance(oper=self, reuse=None, args={})
 140         if mc_list == 'oui':
 141             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         self.check_regles()
 149         self.check_fr()
 150         self.check_reentrant()
 151         self.check_docu()
 152         self.check_nom()
 153         self.check_op(valmin=0)
 154         self.verif_cata_regles()
 155
 156     def supprime(self):
 157         """
 158             Méthode pour supprimer les références arrières susceptibles de provoquer
 159             des cycles de références
 160         """
 161         self.niveau = None