doc/fr/ref_entry_types.rst

   1 ..
   2    Copyright (C) 2008-2015 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 .. _section_ref_entry_types:
  25
  26 Liste des types d'entrées possibles
  27 -----------------------------------
  28
  29 Chaque variable ADAO présente un pseudo-type qui aide à la remplir et à la
  30 valider. Les différents pseudo-types sont:
  31
  32 .. index:: single: Dict
  33
  34 **Dict**
  35     Cela indique une variable qui doit être remplie avec un dictionnaire Python
  36     ``{"clé":"valeur"...}``, usuellement donné soit par une chaîne de caractères
  37     soit par un fichier script.
  38
  39 .. index:: single: Function
  40
  41 **Function**
  42     Cela indique une variable qui doit être donnée comme une fonction Python,
  43     usuellement donnée soit par une chaîne de caractères soit par un fichier
  44     script.
  45
  46 .. index:: single: Matrix
  47
  48 **Matrix**
  49     Cela indique une variable qui doit être donnée comme une matrice,
  50     usuellement donnée soit par une chaîne de caractères soit par un fichier
  51     script.
  52
  53 .. index:: single: ScalarSparseMatrix
  54
  55 **ScalarSparseMatrix**
  56     Cela indique une variable qui doit être donnée comme un nombre unique (qui
  57     sera utilisé pour multiplier une matrice identité), usuellement donné soit
  58     par une chaîne de caractères soit par un fichier script.
  59
  60 .. index:: single: DiagonalSparseMatrix
  61
  62 **DiagonalSparseMatrix**
  63     Cela indique une variable qui doit , (qui sera
  64     utilisé pour remplacer la diagonale d'une matrice identité), usuellement
  65     donné soit par une chaîne de caractères soit par un fichier script.
  66
  67 .. index:: single: Script
  68
  69 **Script**
  70     Cela indique un script donné comme un fichier externe. Il peut être désigné
  71     par un nom de fichier avec chemin complet ou seulement par un nom de fichier
  72     sans le chemin. Si le fichier est donné uniquement par un nom sans chemin,
  73     et si un répertoire d'étude est aussi indiqué, le fichier est recherché dans
  74     le répertoire d'étude donné.
  75
  76 .. index:: single: String
  77
  78 **String**
  79     Cela indique une chaîne de caractères fournissant une représentation
  80     littérale d'une matrice, d'un vecteur ou d'une collection de vecteurs, comme
  81     par exemple "1 2 ; 3 4" ou "[[1,2],[3,4]]" pour une matrice carrée de taille
  82     2x2.
  83
  84 .. index:: single: Vector
  85
  86 **Vector**
  87     Cela indique une variable qui doit être remplie comme un vecteur,
  88     usuellement donné soit par une chaîne de caractères soit par un fichier
  89     script.
  90
  91 .. index:: single: VectorSerie
  92
  93 **VectorSerie**
  94     Cela indique une variable qui doit être remplie comme une liste de vecteurs,
  95     usuellement donnée soit par une chaîne de caractères soit par un fichier
  96     script.
  97
  98 Lorsqu'une commande ou un mot-clé peut être rempli par un nom de fichier script,
  99 ce script doit présenter une variable ou une méthode que porte le même nom que
 100 la variable à remplir. En d'autres mots, lorsque l'on importe le script dans un
 101 noeud Python de YACS, il doit créer une variable du bon nom dans l'espace de
 102 nommage courant du noeud.