Salome HOME
CCAR: Modification principale : ajout de la possibilité d'afficher les noms de
[tools/eficas.git] / Noyau / N_REGLE.py
1 #@ MODIF N_REGLE Noyau  DATE 27/03/2002   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 """
22     Ce module contient la classe mere pour les classes de definition des regles d exclusion.
23
24     La classe REGLE est la classe de base : elle est virtuelle, elle ne doit pas etre instanciee.
25
26     Les classes regles dérivées qui seront instanciées doivent implementer la methode verif
27     dont l argument est le dictionnaire des mots cles effectivement presents
28     sur lesquels sera operee la verification de la regle
29
30     A la creation de l'objet regle on lui passe la liste des noms de mots cles concernes
31
32     Exemple ::
33
34     # Création de l'objet règle UNPARMI
35     r=UNPARMI("INFO","AFFE")
36     # Vérification de la règle r sur le dictionnaire passé en argument
37     r.verif({"INFO":v1,"AFFE":v2)
38 """
39
40 import types
41
42 class REGLE:
43    def __init__(self,*args):
44       """
45           Les classes dérivées peuvent utiliser cet initialiseur par défaut ou
46           le surcharger
47       """
48       self.mcs=args
49
50    def verif(self,args):
51       """
52          Les classes dérivées doivent implémenter cette méthode
53          qui doit retourner une paire dont le premier élément est une chaine de caractère
54          et le deuxième un entier.
55  
56          L'entier peut valoir 0 ou 1. -- s'il vaut 1, la règle est vérifiée
57           s'il vaut 0, la règle n'est pas vérifiée et le texte joint contient
58          un commentaire de la non validité.
59       """
60       raise "NotImplemented : class REGLE should be derived"
61
62    def liste_to_dico(self,args):
63       """
64          Cette méthode est utilitaire pour les seuls besoins
65          des classes dérivées. 
66
67          Elle transforme une liste de noms de mots clés en un 
68          dictionnaire équivalent dont les clés sont les noms des mts-clés
69
70          Ceci permet d'avoir un traitement identique pour les listes et les dictionnaires
71       """
72       if type(args) == types.DictionaryType:
73         return args
74       elif type(args) == types.ListType:
75         dico={}
76         for arg in args :
77           dico[arg]=0
78         return dico
79       else :
80         raise "Erreur ce n'est ni un dictionnaire ni une liste",args
81
82