idl/SALOME_Parametric.idl

   1 //  Copyright (C) 2007-2010  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.
  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 variable exchanged between the
  49     codes. As the variables may be matrices, a value is a 2D object
  50     represented as a sequence of sequences of real numbers.
  51 */
  52   typedef sequence<sequence<double> > Value;
  53
  54 /*! \brief List of variable names.
  55 */
  56   typedef sequence<string> VarList;
  57
  58 /*! \brief List of variable values.
  59 */
  60   typedef sequence<Value> ValueList;
  61
  62 /*! \brief Structure describing the input of a computation code.
  63 */
  64   struct ParametricInput {
  65     VarList inputVarList;
  66     VarList outputVarList;
  67     ValueList inputValues;
  68     ParameterList specificParameters;
  69   };
  70
  71 /*! \brief Structure describing the output of a computation code.
  72 */
  73   struct ParametricOutput {
  74     ValueList outputValues;
  75     ParameterList specificOutputInfos;
  76     long returnCode;
  77     string errorMessage;
  78   };
  79
  80 };
  81
  82 #endif