Salome HOME
Updating documentation by review and snippets (4)
[modules/adao.git] / doc / fr / ref_algorithm_FunctionTest.rst
1 ..
2    Copyright (C) 2008-2019 EDF R&D
3
4    This file is part of SALOME ADAO module.
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    This library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19
20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21
22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
23
24 .. index:: single: FunctionTest
25 .. _section_ref_algorithm_FunctionTest:
26
27 Algorithme de vérification "*FunctionTest*"
28 -------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 Cet algorithme permet de vérifier que l'opérateur d'observation fonctionne
34 correctement et que son appel se déroule de manière compatible avec son usage
35 dans les algorithmes d'ADAO. De manière pratique, il permet d'appeler une ou
36 plusieurs fois l'opérateur, en activant ou non le mode "debug" lors de
37 l'exécution.
38
39 Une statistique sur les vecteurs en entrée et en sortie de chaque exécution de
40 l'opérateur est indiquée, et une autre globale est fournie de manière
41 récapitulative à la fin de l'algorithme de vérification. La précision
42 d'affichage est contrôlable pour permettre l'automatisation des tests
43 d'opérateur.
44
45 .. ------------------------------------ ..
46 .. include:: snippets/Header2Algo02.rst
47
48 .. include:: snippets/CheckingPoint.rst
49
50 .. include:: snippets/ObservationOperator.rst
51
52 .. ------------------------------------ ..
53 .. include:: snippets/Header2Algo03Chck.rst
54
55 .. include:: snippets/NumberOfPrintedDigits.rst
56
57 .. include:: snippets/NumberOfRepetition.rst
58
59 .. include:: snippets/SetDebug.rst
60
61 StoreSupplementaryCalculations
62   .. index:: single: StoreSupplementaryCalculations
63
64   Cette liste indique les noms des variables supplémentaires qui peuvent être
65   disponibles à la fin de l'algorithme. Cela implique potentiellement des
66   calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
67   aucune de ces variables n'étant calculée et stockée par défaut. Les noms
68   possibles sont dans la liste suivante : [
69   "CurrentState",
70   "SimulatedObservationAtCurrentState",
71   ].
72
73   Exemple :
74   ``{"StoreSupplementaryCalculations":["CurrentState"]}``
75
76 .. ------------------------------------ ..
77 .. include:: snippets/Header2Algo04.rst
78
79 *Aucune*
80
81 .. ------------------------------------ ..
82 .. include:: snippets/Header2Algo05.rst
83
84 .. include:: snippets/CurrentState.rst
85
86 .. include:: snippets/SimulatedObservationAtCurrentState.rst
87
88 .. ------------------------------------ ..
89 .. include:: snippets/Header2Algo06.rst
90
91 - :ref:`section_ref_algorithm_LinearityTest`