Salome HOME
onditional use 'Read The Docs' theme for documentation (Tuleap [bos #18858])
[modules/eficas.git] / doc / eficas_rules.rst
1 .. _rules-label:
2
3 ============
4 Eficas rules 
5 ============
6
7 All the rules can be combinated, creating more complicated rules.
8
9 AU_MOINS_UN
10 -----------
11
12     AU_MOINS_UN rule obliges the user to create at least one concept of the list. More than one can be created. 
13
14 -    Example
15
16      Keyword POUTRE in OPER AFFE_CARA_ELEM contains the rule :
17
18     regles=(AU_MOINS_UN(
19     'POUTRE','COQUE','DISCRET','CABLE','BARRE','MASSIF','ASSE_GRIL','GRILLE'),)
20
21 -     That means if AFFE_CARA_ELEM is used in the JDC, the user must select one at least of the Keyword between POUTRE, COQUE, DISCRET, CABLE, BARRE, MASSIF, ASSE_GRIL, GRILLE :
22
23        * If the user doesn't select any of these keywords, AFFE_CARA_ELEM is unvalid. 
24        * If he selects POUTRE, AFFE_CARA_ELEM is valid. 
25        * If he selects both  POUTRE and DISCRET, AFFE_CARA_ELEM is valid. 
26     
27
28 UN_PARMI
29 --------
30
31     AU_MOINS_UN rule obliges the user to create  one and only one concept of the list.
32
33 -    Example
34
35      Oper AFFE_CHAR_MECA contains the rules :
36
37                  regles=(UN_PARMI('VECT_Y','ANGL_VRIL'),
38
39 -     That means if AFFE_CHAR_MECA is used in the JDC, the user must select VECT_Y or ANGL_VRIL.
40
41        * If the user doesn't select any of these keywords, DEFI_GROUP is unvalid. 
42        * If he selects only VECT_Y, DEFI_GROUP is valid. 
43        * Eficas will not proposed the keyword ANGL_VRIL if VECT_Y already exists.
44
45
46 EXCLUS
47 ------
48
49     EXCLUS means that, if one of the keyword is created, the other won't be allowed. 
50  
51  -   Example :
52      DEFI_SQUELETTE contains the rules :
53
54                      EXCLUS('SOUS_STRUC','SECTEUR')
55
56 -     That means if DEFI_SQUELETTE is used in the JDC
57
58        * If the user doesn't select any of these keywords, DEFI_SQUELETTE  is  valid. 
59        * If he selects only SOUS_STRUC, DEFI_SQUELETTE is valid. 
60        * Eficas will not proposed the keyword SECTEUR if SOUS_STRUC already exists.
61
62 ENSEMBLE
63 --------
64
65     the rule means that if one keyword is selected, the others have to be also.
66     the keywords order is not meaningful.
67
68 -    Example
69
70     GRILLE in  AFFE_CARA_ELEM, contains :
71
72                        ENSEMBLE('ORIG_AXE','AXE')
73
74 -   That means if GRILLE is used in the JDC
75
76        * If the user doesn't select any of these keywords, GRILLE  is  valid. 
77        * If he selects only ORIG_AXE, GRILLE is invalid. 
78        * If he selects both ORIG_AXE and AXE, GRILLE is valid. 
79
80 PRESENT_PRESENT
81 ---------------
82
83     the rule means that if the FIRST keyword is selected, the others have to be also.
84
85 -     Example
86
87     MACRO_MISS_3D contains the rule
88
89                      PRESENT_PRESENT('FREQ_MIN','FREQ_MAX','FREQ_PAS')
90
91 -   That means if MACRO_MISS_3D is used in the JDC
92
93        * If the user doesn't select any of these keywords, GRILLE  is  valid. 
94        * If he selects only FREQ_MAX, GRILLE is unvalid. 
95        * If he selects only FREQ_PAS, GRILLE is valid. 
96        * If he selects only FREQ_MIN, GRILLE is invalid. 
97        * If he selects both FREQ_MIN, FREQ_MAX  and FREQ_PAS, GRILLE is valid. 
98
99
100 PRESENT_ABSENT
101 --------------
102
103     the rule means that if the FIRST keyword is selected, the others aren't allowed.
104
105 -    Example
106      FORCE_COQUE in AFFE_CHAR_MECA contains 
107
108                  regles=( PRESENT_ABSENT('FX','PRES','F1','F2','F3','MF1','MF2'),
109
110 -   That means if FORCE_COQUE is used in the JDC
111
112        * If the user doesn't select any of these keywords, FORCE_COQUE  is  valid. 
113        * If he selects only FX, FORCE_COQUE is valid. 
114        * If he selects both PRES and F1, FORCE_COQUE is valid. 
115
116
117      
118
119