doc/en/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 List of possible input types
  27 ----------------------------
  28
  29 .. index:: single: Dict
  30 .. index:: single: Function
  31 .. index:: single: Matrix
  32 .. index:: single: ScalarSparseMatrix
  33 .. index:: single: DiagonalSparseMatrix
  34 .. index:: single: String
  35 .. index:: single: Script
  36 .. index:: single: Vector
  37
  38 Each ADAO variable has a pseudo-type to help filling it and validation. The
  39 different pseudo-types are:
  40
  41 .. index:: single: Dict
  42
  43 **Dict**
  44     This indicates a variable that has to be filled by a Python dictionary
  45     ``{"key":"value...}``, usually given either as a string or as a script file.
  46
  47 .. index:: single: Function
  48
  49 **Function**
  50     This indicates a variable that has to be filled by a Python function,
  51     usually given as a script file or a component method.
  52
  53 .. index:: single: Matrix
  54
  55 **Matrix**
  56     This indicates a variable that has to be filled by a matrix, usually given
  57     either as a string or as a script file.
  58
  59 .. index:: single: ScalarSparseMatrix
  60
  61 **ScalarSparseMatrix**
  62     This indicates a variable that has to be filled by a unique number (which
  63     will be used to multiply an identity matrix), usually given either as a
  64     string or as a script file.
  65
  66 .. index:: single: DiagonalSparseMatrix
  67
  68 **DiagonalSparseMatrix**
  69     This indicates a variable that has to be filled by a vector (which will be
  70     used to replace the diagonal of an identity matrix), usually given either as
  71     a string or as a script file.
  72
  73 .. index:: single: Script
  74
  75 **Script**
  76     This indicates a script given as an external file. It can be described by a
  77     full absolute path name or only by the file name without path. If the file
  78     is given only by a file name without path, and if a study directory is also
  79     indicated, the file is searched in the given directory.
  80
  81 .. index:: single: String
  82
  83 **String**
  84     This indicates a string giving a literal representation of a matrix, a
  85     vector or a vector series, such as "1 2 ; 3 4" or "[[1,2],[3,4]]" for a
  86     square 2x2 matrix.
  87
  88 .. index:: single: Vector
  89
  90 **Vector**
  91     This indicates a variable that has to be filled by a vector, usually given
  92     either as a string or as a script file.
  93
  94 .. index:: single: VectorSerie
  95
  96 **VectorSerie**
  97     This indicates a variable that has to be filled by a list of
  98     vectors, usually given either as a string or as a script file.
  99
 100 When a command or keyword can be filled by a script file name, the script has to
 101 contain a variable or a method that has the same name as the one to be filled.
 102 In other words, when importing the script in a YACS Python node, it must create
 103 a variable of the good name in the current name space of the node.