idl/SALOME_Parametric.idl

   1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   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
  23 //  File   : SALOME_Parametric.idl
  24 //  Author : Renaud BARATE, EDF R&D
  25 //
  26
  27 #ifndef _SALOME_Parametric_IDL_
  28 #define _SALOME_Parametric_IDL_
  29
  30 /*! \brief
  31      This module contains type definitions for the communication between
  32      supervision codes and computation codes in parametric studies.
  33 */
  34 module SALOME_TYPES
  35 {
  36 /*! \brief Structure describing a parameter that can be used for specific
  37     information exchange between the codes.
  38 */
  39   struct Parameter {
  40     string name;
  41     string value;
  42   };
  43
  44 /*! \brief List of parameters.
  45 */
  46   typedef sequence<Parameter> ParameterList;
  47
  48 /*! \brief Type representing the value of a single variable exchanged between
  49     the codes (e.g. a force "F"). As the variables may be vectors (or even
  50     matrices), their value is represented as a sequence of real numbers.
  51 */
  52   typedef sequence<double> Variable;
  53
  54 /*! \brief Type representing a state, i.e. a set containing the values of all
  55     the variables of interest.
  56 */
  57   typedef sequence<Variable> VariableSequence;
  58
  59 /*! \brief Type representing a set of states.
  60 */
  61   typedef sequence<VariableSequence> StateSequence;
  62
  63 /*! \brief Type representing a time sequence, with a set of states for each
  64     time step. Hence it is represented as a sequence of StateSequence.
  65 */
  66   typedef sequence<StateSequence> TimeSequence;
  67
  68 /*! \brief List of variable names.
  69 */
  70   typedef sequence<string> VarList;
  71
  72 /*! \brief Structure describing the input of a computation code.
  73 */
  74   struct ParametricInput {
  75     VarList inputVarList;
  76     VarList outputVarList;
  77     TimeSequence inputValues;
  78     ParameterList specificParameters;
  79   };
  80
  81 /*! \brief Structure describing the output of a computation code.
  82 */
  83   struct ParametricOutput {
  84     TimeSequence outputValues;
  85     ParameterList specificOutputInfos;
  86     long returnCode;
  87     string errorMessage;
  88   };
  89
  90 };
  91
  92 #endif