Doc/eficas_notions.rst

   1 .. _concept-label:
   2
   3 Eficas Concepts
   4 ================
   5
   6 Commands in the Data Set (or JDC Jeu De Commandes )
   7 ---------------------------------------------------
   8
   9 A dataset is made of a collection of commands. Each command have parameters (keywords). They can return concept or not:
  10
  11 * Command not returning concept : they are described as "PROC" in catalogs.
  12
  13   - example:
  14          - DEBUT() is a proc.
  15          - for ASTER, it initializes memory and files.
  16
  17 * Command returning a concept :
  18   The concept has a specific type (defined in the catalog) and a name (given by the user).  These commandes are described as "OPER" in catalogs.
  19
  20   - example :
  21          - MONMAIL=LIRE_MAILLAGE(UNITE=20);
  22          - This line creates a new concept MONMAIL of type "maillage", which can be re-used as entry for another keyword.
  23
  24   When an object is valid, the user has to named it. In tree view, a yellow square shows valid objects that have to be nammed.
  25
  26 Commands are composed of keywords, or groups of keywords.  These items are associated according to rules or conditions.
  27 They are described in the catalog.
  28
  29
  30 Keywords
  31 ---------
  32
  33 * Group of keywords  (mot-clef facteur )
  34
  35    This is a list of keywords which jointly have a meaning for the code.
  36    It is composed of group of keywords and simple keywords.
  37    Some are mandatory, repeatable.
  38    This list can depend on conditionnal rules.
  39
  40
  41 * Simple keyword (mot-clef simple) .
  42
  43    This is a parameter. It also can be mandatory or not.
  44    It has attributes.
  45
  46
  47 Attributes of a keyword
  48 ---------------------------
  49
  50 a parameter (simple keyword or "mot-clef simple") has :
  51
  52 - a type : real, string, complex, integer, matrix, file (existing or allready existing), directory or a concept class which is defined in the catalog.
  53 - a cardinality.
  54
  55 a parameter (simple keyword or "mot-clef simple") should have :
  56
  57 - a default value
  58 - a short documentation
  59 - a long documentation
  60 - an interval of values
  61 - a set of discrete values
  62
  63
  64 Input data panel depends on both these attributes. Eficas ensures that data are valid. It forces the user to enter a list if needed, it verifies the input type. It displays only possible values.
  65
  66
  67