doc/fr/ref_entry_types.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 .. _section_ref_entry_types:
  25
  26 Liste des types d'entrées possibles pour les variables utilisateurs
  27 -------------------------------------------------------------------
  28
  29 Chaque variable à renseigner pour l'utilisation d'ADAO peut être représentée à
  30 l'aide de "pseudo-types" particuliers, qui aident à la remplir logiquement et à
  31 la valider informatiquement. Ces pseudo-types représentent explicitement des
  32 formes mathématiques (:ref:`section_ref_entry_types_math`) ou informatiques
  33 simples (:ref:`section_ref_entry_types_info`), que l'on détaille ici. On
  34 utilise aussi les :ref:`section_notations`, en même temps que les
  35 :ref:`section_ref_entry_types_names`.
  36
  37 .. _section_ref_entry_types_math:
  38
  39 Pseudo-types de représentation mathématique des données
  40 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
  41
  42 Les entrées sont décrites selon une logique la plus simple possible, de
  43 représentation mathématique, pour des algorithmes ou outils de calculs.
  44
  45 .. include:: snippets/EntryTypeVector.rst
  46
  47 .. include:: snippets/EntryTypeVectorSerie.rst
  48
  49 .. include:: snippets/EntryTypeMatrix.rst
  50
  51 .. include:: snippets/EntryTypeFunction.rst
  52
  53 .. include:: snippets/EntryTypeDict.rst
  54
  55 Les variables auxquelles ces pseudo-types s'appliquent peuvent elles-mêmes être
  56 données à l'aide des descriptions informatiques qui suivent.
  57
  58 .. _section_ref_entry_types_info:
  59
  60 Pseudo-types de description informatique des données
  61 ++++++++++++++++++++++++++++++++++++++++++++++++++++
  62
  63 Trois pseudo-types, purement informatiques, permettent de désigner la manière
  64 dont on fournit les variables en entrée.
  65
  66 .. include:: snippets/EntryTypeScript.rst
  67
  68 .. include:: snippets/EntryTypeString.rst
  69
  70 .. include:: snippets/EntryTypeDataFile.rst
  71
  72 .. _section_ref_entry_types_names:
  73
  74 Informations sur les noms imposés pour les entrées par fichier
  75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  76
  77 Lorsqu'une commande ou un mot-clé peuvent être renseignés à l'aide d'un fichier
  78 script désigné par le pseudo-type "*Script*", ce script doit présenter une
  79 variable ou une méthode qui porte le même nom que la variable à remplir. En
  80 d'autres termes, lorsque l'on importe un tel script dans une commande Python ou
  81 un noeud Python de YACS, il doit créer une variable du bon nom dans l'espace de
  82 nommage courant du noeud. Par exemple, un script Python rendant disponible la
  83 variable d'ébauche, nommée "*Background*", doit présenter la forme suivante ::
  84
  85     ...
  86     ...
  87     Background =...
  88     ...
  89     ...
  90
  91 Son importation permet ainsi de créer la variable "*Background*" dans l'espace
  92 de nommage courant. Les points "..." symbolisent du code quelconque autour de
  93 ce début particulier de ligne.
  94
  95 De la même manière, lorsqu'un vecteur particulier peut être renseigné à l'aide
  96 d'un fichier de données désigné par le pseudo-type "*DataFile*", les
  97 informations présentes dans le fichier "*DataFile*" doivent porter le nom du
  98 vecteur à charger.