Salome HOME
787b45dd8a3ec75b50656b61e104194a660b37bc
[tools/eficas.git] / Noyau / N_REGLE.py
1 # -*- coding: utf-8 -*-
2 #@ MODIF N_REGLE Noyau  DATE 27/03/2002   AUTEUR DURAND C.DURAND 
3 #            CONFIGURATION MANAGEMENT OF EDF VERSION
4 # ======================================================================
5 # COPYRIGHT (C) 1991 - 2002  EDF R&D                  WWW.CODE-ASTER.ORG
6 # THIS PROGRAM IS FREE SOFTWARE; YOU CAN REDISTRIBUTE IT AND/OR MODIFY
7 # IT UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE AS PUBLISHED BY
8 # THE FREE SOFTWARE FOUNDATION; EITHER VERSION 2 OF THE LICENSE, OR   
9 # (AT YOUR OPTION) ANY LATER VERSION.                                 
10 #
11 # THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT 
12 # WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY OF          
13 # MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE GNU    
14 # GENERAL PUBLIC LICENSE FOR MORE DETAILS.                            
15 #
16 # YOU SHOULD HAVE RECEIVED A COPY OF THE GNU GENERAL PUBLIC LICENSE   
17 # ALONG WITH THIS PROGRAM; IF NOT, WRITE TO EDF R&D CODE_ASTER,       
18 #    1 AVENUE DU GENERAL DE GAULLE, 92141 CLAMART CEDEX, FRANCE.      
19 #                                                                       
20 #                                                                       
21 # ======================================================================
22 """
23     Ce module contient la classe mere pour les classes de definition des regles d exclusion.
24
25     La classe REGLE est la classe de base : elle est virtuelle, elle ne doit pas etre instanciee.
26
27     Les classes regles dérivées qui seront instanciées doivent implementer la methode verif
28     dont l argument est le dictionnaire des mots cles effectivement presents
29     sur lesquels sera operee la verification de la regle
30
31     A la creation de l'objet regle on lui passe la liste des noms de mots cles concernes
32
33     Exemple ::
34
35     # Création de l'objet règle UNPARMI
36     r=UNPARMI("INFO","AFFE")
37     # Vérification de la règle r sur le dictionnaire passé en argument
38     r.verif({"INFO":v1,"AFFE":v2)
39 """
40
41 import types
42
43 class REGLE:
44    def __init__(self,*args):
45       """
46           Les classes dérivées peuvent utiliser cet initialiseur par défaut ou
47           le surcharger
48       """
49       self.mcs=args
50
51    def verif(self,args):
52       """
53          Les classes dérivées doivent implémenter cette méthode
54          qui doit retourner une paire dont le premier élément est une chaine de caractère
55          et le deuxième un entier.
56  
57          L'entier peut valoir 0 ou 1. -- s'il vaut 1, la règle est vérifiée
58           s'il vaut 0, la règle n'est pas vérifiée et le texte joint contient
59          un commentaire de la non validité.
60       """
61       raise "NotImplemented : class REGLE should be derived"
62
63    def liste_to_dico(self,args):
64       """
65          Cette méthode est utilitaire pour les seuls besoins
66          des classes dérivées. 
67
68          Elle transforme une liste de noms de mots clés en un 
69          dictionnaire équivalent dont les clés sont les noms des mts-clés
70
71          Ceci permet d'avoir un traitement identique pour les listes et les dictionnaires
72       """
73       if type(args) == types.DictionaryType:
74         return args
75       elif type(args) == types.ListType:
76         dico={}
77         for arg in args :
78           dico[arg]=0
79         return dico
80       else :
81         raise "Erreur ce n'est ni un dictionnaire ni une liste",args
82
83