2 Copyright (C) 2008-2017 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. _section_ref_entry_types:
26 Liste des types d'entrées possibles
27 -----------------------------------
29 Chaque variable ADAO présente un pseudo-type qui aide à la remplir et à la
30 valider. Ces pseudo-types représentent explicitement des formes informatiques ou
31 mathématiques simples. Deux pseudo-types, purement informatiques, permettent de
32 désigner la manière dont on fournit les variables en entrée:
34 .. index:: single: Script
37 Cela indique un script donné comme un fichier externe. Il peut être désigné
38 par un nom de fichier avec chemin complet ou seulement par un nom de fichier
39 sans le chemin. Si le fichier est donné uniquement par un nom sans chemin,
40 et si un répertoire d'étude est aussi indiqué, le fichier est recherché dans
41 le répertoire d'étude donné.
43 .. index:: single: String
46 Cela indique une chaîne de caractères fournissant une représentation
47 littérale d'une matrice, d'un vecteur ou d'une collection de vecteurs, comme
48 par exemple "1 2 ; 3 4" ou "[[1,2],[3,4]]" pour une matrice carrée de taille
51 Les différents autres pseudo-types sont les suivants. Les variables auxquelles
52 ils s'appliquent peuvent elles-mêmes être données soit par une chaîne de
53 caractères (un "*String*"), soit par un fichier script (un "*Script*"):
55 .. index:: single: Dict
58 Cela indique une variable qui doit être remplie avec un dictionnaire Python
59 ``{"clé":"valeur"...}``.
61 .. index:: single: Function
64 Cela indique une variable qui doit être donnée comme une fonction Python.
65 Les fonctions sont des entrées spéciales décrites par des
66 :ref:`section_ref_operator_requirements`.
68 .. index:: single: Matrix
71 Cela indique une variable qui doit être donnée comme une matrice.
73 .. index:: single: ScalarSparseMatrix
75 **ScalarSparseMatrix**
76 Cela indique une variable qui doit être donnée comme un nombre unique (qui
77 sera ensuite utilisé pour multiplier une matrice identité).
79 .. index:: single: DiagonalSparseMatrix
81 **DiagonalSparseMatrix**
82 Cela indique une variable qui doit doit être donnée comme un vecteur, (qui
83 sera ensuite utilisé comme la diagonale d'une matrice carrée).
85 .. index:: single: Vector
88 Cela indique une variable qui doit être remplie comme un vecteur.
90 .. index:: single: VectorSerie
93 Cela indique une variable qui doit être remplie comme une liste de vecteurs.
95 Lorsqu'une commande ou un mot-clé peut être rempli par un nom de fichier script
96 désigné par le pseudo-type "*Script*", ce script doit présenter une variable ou
97 une méthode que porte le même nom que la variable à remplir. En d'autres termes,
98 lorsque l'on importe le script dans un noeud Python de YACS, il doit créer une
99 variable du bon nom dans l'espace de nommage courant du noeud. Par exemple, un
100 script Python rendant disponible la variable d'ébauche, nommée "*Background*",
101 doit présenter la forme suivante::
107 Son importation permet ainsi de créer la variable "*Background*". Les points
108 "..." symbolisent du code quelconque autour de ce début particulier de ligne.