Salome HOME
CCAR: ajout du repertoire Doc qui contient un Makefile pour générer une doc
[tools/eficas.git] / Noyau / N_FACT.py
1 #@ MODIF N_FACT Noyau  DATE 09/09/2003   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 """ Ce module contient la classe de definition FACT
22     qui permet de spécifier les caractéristiques des mots clés facteurs
23 """
24
25 import types
26
27 import N_ENTITE
28 import N_MCFACT
29 import N_MCLIST
30
31 class FACT(N_ENTITE.ENTITE):
32    """
33     Classe pour definir un mot cle facteur
34
35     Cette classe a trois attributs de classe 
36
37           - class_instance qui indique la classe qui devra etre utilisée 
38                   pour créer l'objet qui servira à controler la conformité d'un 
39                   mot-clé facteur avec sa définition
40           - list_instance
41           - label qui indique la nature de l'objet de définition (ici, FACT)
42    """
43    class_instance = N_MCFACT.MCFACT
44    list_instance = N_MCLIST.MCList
45    label = 'FACT'
46
47    def __init__(self,fr="",ang="",docu="",regles=(),statut='f',defaut=None,
48                      min=0,max=1,validators=None,**args):
49      
50       """
51           Un mot-clé facteur est caractérisé par les attributs suivants :
52
53              - fr   :
54              - ang :
55              - statut :
56              - defaut :
57              - regles
58              - min
59              - max
60              - position
61              - docu
62       """
63       N_ENTITE.ENTITE.__init__(self,validators)
64       # Initialisation des attributs
65       self.fr=fr
66       self.ang=ang
67       self.docu = docu
68       if type(regles)== types.TupleType:
69           self.regles=regles
70       else:
71           self.regles=(regles,)
72       self.statut=statut
73       self.defaut=defaut
74       self.min=min
75       self.max=max
76       self.entites=args
77       self.position=None
78       self.affecter_parente()
79
80    def __call__(self,val,nom,parent):
81       """
82           Construit la structure de donnee pour un mot cle facteur a partir 
83           de sa definition (self) de sa valeur (val), de son nom (nom) et de 
84           son parent dans l arboresence (parent)
85           
86           Suivant le type de la valeur on retournera soit un objet de type 
87           MCFACT soit une liste de type MCLIST.
88
89           La creation d un mot cle facteur depend de son statut
90              - Si statut ='o'   il est obligatoire
91              - Si statut == 'd' il est facultatif mais ses sous mots cles avec 
92                            defaut sont visibles
93              - Si statut == 'f' il est facultatif et ses sous mots avec defaut ne 
94                            sont pas visibles
95              - Si statut == 'c' il est cache ???
96              - Si defaut != None, on utilise cette valeur pour calculer la valeur 
97                            par defaut du mot cle facteur
98       """
99       if val == None:
100         if self.defaut == None:
101           val={}
102         elif type(self.defaut) == types.TupleType:
103           val=self.defaut
104               # Est ce utile ? Le défaut pourrait etre uniquement un dict
105         elif type(self.defaut) == types.DictType or isinstance(self.defaut,N_MCFACT._F):
106           val=self.defaut
107         else:
108           # On ne devrait jamais passer par la
109           print "On ne devrait jamais passer par la"
110           return None
111
112       if type(val) == types.TupleType or type(val) == types.ListType :
113         # on est en présence d'un MCFACT multiple !
114         l=self.list_instance()
115         l.init(nom = nom,parent=parent)
116         for v in val:
117           objet=self.class_instance(nom=nom,definition=self,val=v,parent=parent)
118           l.append(objet)
119         return l
120       else:
121         return self.class_instance(nom=nom,definition=self,val=val,parent=parent)
122
123
124    def verif_cata(self):
125       if type(self.min) != types.IntType :
126          if self.min != '**':
127             self.cr.fatal("L'attribut 'min' doit etre un entier : %s" %`self.min`)
128       if type(self.max) != types.IntType :
129          if self.max != '**':
130             self.cr.fatal("L'attribut 'max' doit etre un entier : %s" %`self.max`)
131       if self.min > self.max :
132          self.cr.fatal("Nombres d'occurrence min et max invalides : %s %s" %(`self.min`,`self.max`))
133       if type(self.fr) != types.StringType :
134          self.cr.fatal("L'attribut 'fr' doit etre une chaine de caractères : %s" %`self.fr`)
135       if type(self.regles) != types.TupleType :
136          self.cr.fatal("L'attribut 'regles' doit etre un tuple : %s" %`self.regles`)
137       if self.statut not in ['f','o','c','d'] :
138          self.cr.fatal("L'attribut 'statut' doit valoir 'o','f','c' ou 'd' : %s" %`self.statut`)
139       if type(self.docu) != types.StringType :
140          self.cr.fatal("L'attribut 'docu' doit etre une chaine de caractères : %s" %`self.docu`)
141       if self.validators and not self.validators.verif_cata():
142          self.cr.fatal("Un des validateurs est incorrect. Raison : "+self.validators.cata_info)
143       self.verif_cata_regles()
144