idl/MEDCalculator.idl

   1 //  Copyright (C) 2011  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  This library is free software; you can redistribute it and/or
   4 //  modify it under the terms of the GNU Lesser General Public
   5 //  License as published by the Free Software Foundation; either
   6 //  version 2.1 of the License.
   7 //
   8 //  This library is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 //  Lesser General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU Lesser General Public
  14 //  License along with this library; if not, write to the Free Software
  15 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // Authors : Guillaume Boulant (EDF) - 01/06/2011
  20
  21 #ifndef _MED_CALCULATOR_IDL_
  22 #define _MED_CALCULATOR_IDL_
  23
  24 #include "SALOME_GenericObj.idl"
  25 #include "MEDDataManager.idl"
  26
  27 module MEDOP
  28 {
  29
  30   /*!
  31    * This constants may be used for the value of an argument of a
  32    * function of the interface to specify that the function must
  33    * consider a default value.
  34    */
  35   typedef long medopNumber;
  36   const medopNumber NBCOMP_DEFAULT=-1;
  37
  38   interface MEDCalculator: SALOME::GenericObj
  39   {
  40     /*! Addition of the fields f1 and f2 ( f1+f2) */
  41     FieldHandler add(in FieldHandler f1, in FieldHandler f2)
  42       raises (SALOME::SALOME_Exception);
  43     /*! Substraction of the fields f1 and f2 (f1-f2) */
  44     FieldHandler sub(in FieldHandler f1, in FieldHandler f2)
  45       raises (SALOME::SALOME_Exception);
  46     /*! Multiplication of the fields f1 by f2 (f1*f2) */
  47     FieldHandler mul(in FieldHandler f1, in FieldHandler f2)
  48       raises (SALOME::SALOME_Exception);
  49     /*! Division of the fields f1 by f2 (f1/f2) */
  50     FieldHandler div(in FieldHandler f1, in FieldHandler f2)
  51       raises (SALOME::SALOME_Exception);
  52     /*! Power of the field f (f^power) */
  53     FieldHandler pow(in FieldHandler f, in long power)
  54       raises (SALOME::SALOME_Exception);
  55     /*! Linear transformation of the field f (factor*f+offset) */
  56     FieldHandler lin(in FieldHandler f, in double factor, in double offset)
  57       raises (SALOME::SALOME_Exception);
  58     /*! Dublication of the field f */
  59     FieldHandler dup(in FieldHandler f)
  60       raises (SALOME::SALOME_Exception);
  61
  62     /*! Creation of a field whose values are initialized with the specified double */
  63     /* FieldHandler ini(in double value) raises (SALOME::SALOME_Exception); */
  64
  65     /*! Transformation of the field f using a custom function */
  66     FieldHandler fct(in FieldHandler f, in string function, in medopNumber nbResComponents)
  67       raises (SALOME::SALOME_Exception);
  68
  69   };
  70 };
  71
  72 #endif // _MED_CALCULATOR_IDL_