Extensions/commentaire.py

   1 #            CONFIGURATION MANAGEMENT OF EDF VERSION
   2 # ======================================================================
   3 # COPYRIGHT (C) 1991 - 2002  EDF R&D                  WWW.CODE-ASTER.ORG
   4 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
   5 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
   6 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR
   7 # (AT YOUR OPTION) ANY LATER VERSION.
   8 #
   9 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT
  10 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF
  11 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU
  12 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.
  13 #
  14 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE
  15 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,
  16 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.
  17 #
  18 #
  19 # ======================================================================
  20 """
  21    Ce module contient la classe COMMENTAIRE qui sert dans EFICAS
  22    pour gérer les commentaires dans un JDC
  23 """
  24
  25 from Noyau.N_CR import CR
  26
  27 class COMMENTAIRE :
  28   """
  29       Cette classe permet de créer des objets de type COMMENTAIRE
  30   """
  31   nature = 'COMMENTAIRE'
  32   idracine = '_comm'
  33
  34   def __init__(self,valeur,parent=None):
  35     # parent est un objet de type OBJECT (ETAPE ou MC ou JDC...)
  36     self.valeur=valeur
  37     if not parent :
  38       self.jdc = self.parent = CONTEXT.get_current_step()
  39     else:
  40       self.jdc = self.parent = parent
  41     # La classe COMMENTAIRE n'a pas de définition. On utilise self
  42     # pour complétude
  43     self.definition=self
  44     self.nom=''
  45     self.niveau = self.parent.niveau
  46     self.actif=1
  47     self.register()
  48
  49   def register(self):
  50     """
  51         Enregistre le commentaire dans la liste des étapes de son parent
  52         lorsque celui-ci est un JDC
  53     """
  54     if self.parent.nature == 'JDC':
  55       # le commentaire est entre deux commandes:
  56       # il faut l'enregistrer dans la liste des étapes
  57       self.parent.register(self)
  58
  59   def isvalid(self):
  60     """
  61     Retourne 1 si self est valide, 0 sinon
  62     Retourne toujours 1 car un commentaire est toujours valide
  63     """
  64     return 1
  65
  66   def isoblig(self):
  67     """ Indique si self est obligatoire ou non : retourne toujours 0 """
  68     return 0
  69
  70   def isrepetable(self):
  71     """ Indique si self est répétable ou non : retourne toujours 1 """
  72     return 1
  73
  74   def active(self):
  75       """
  76       Rend l'etape courante active
  77       """
  78       self.actif = 1
  79
  80   def inactive(self):
  81       """
  82       Rend l'etape courante inactive
  83       NB : un commentaire est toujours actif !
  84       """
  85       self.actif = 1
  86
  87   def isactif(self):
  88       """
  89       Booléenne qui retourne 1 si self est valide, 0 sinon
  90       """
  91       return self.actif
  92
  93   def supprime(self):
  94       """
  95       Méthode qui supprime toutes les boucles de références afin que
  96       l'objet puisse être correctement détruit par le garbage collector
  97       """
  98       self.parent=None
  99       self.jdc=None
 100       self.definition = None
 101       self.niveau = None
 102
 103   def liste_mc_presents(self):
 104       return []
 105
 106   def get_valeur(self) :
 107     """ Retourne la valeur de self, cad le contenu du commentaire """
 108     try :
 109       return self.valeur
 110     except:
 111       return None
 112
 113   def set_valeur(self,new_valeur):
 114     """
 115         Remplace la valeur de self(si elle existe) par new_valeur
 116     """
 117     self.valeur = new_valeur
 118     self.init_modif()
 119
 120   def init_modif(self):
 121     self.state = 'modified'
 122     if self.parent:
 123       self.parent.init_modif()
 124
 125   def supprime_sdprods(self):
 126     pass
 127
 128   def update_context(self,d):
 129     """
 130         Update le dictionnaire d avec les concepts ou objets produits par self
 131         --> ne fait rien pour un commentaire
 132     """
 133     pass
 134
 135   def report(self):
 136     """ Génère l'objet rapport (classe CR) """
 137     self.cr=CR()
 138     if not self.isvalid(): self.cr.warn("Objet commentaire non valorisé")
 139     return self.cr
 140
 141   def ident(self):
 142     """ Retourne le nom interne associé à self
 143         Ce nom n'est jamais vu par l'utilisateur dans EFICAS
 144     """
 145     return self.nom
 146
 147   def delete_concept(self,sd):
 148     pass
 149
 150   def verif_condition_bloc(self):
 151     """
 152         Evalue les conditions de tous les blocs fils possibles
 153         (en fonction du catalogue donc de la définition) de self et
 154         retourne deux listes :
 155         - la première contient les noms des blocs à rajouter
 156         - la seconde contient les noms des blocs à supprimer
 157     """
 158     return [],[]
 159
 160   def verif_condition_regles(self,liste_presents):
 161     """
 162         Retourne la liste des mots-clés à rajouter pour satisfaire les règles
 163         en fonction de la liste des mots-clés présents
 164     """
 165     return []
 166
 167   def get_sdprods(self,nom_sd):
 168      """
 169          Retourne les concepts produits par la commande
 170      """
 171      return None
 172
 173   def verif_existence_sd(self):
 174      pass
 175
 176   def get_fr(self):
 177     """
 178     Retourne le commentaire lui meme tronque a la 1ere ligne
 179     """
 180     return self.valeur.split('\n',1)[0]
 181