idl/MEDCalculator.idl

   1 // Copyright (C) 2011-2019  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, or (at your option) any later version.
   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
  20 // Authors : Guillaume Boulant (EDF) - 01/06/2011
  21
  22 #ifndef _MED_CALCULATOR_IDL_
  23 #define _MED_CALCULATOR_IDL_
  24
  25 #include "SALOME_GenericObj.idl"
  26 #include "MEDDataManager.idl"
  27
  28 module MEDCALC
  29 {
  30
  31   /*!
  32    * This constants may be used for the value of an argument of a
  33    * function of the interface to specify that the function must
  34    * consider a default value.
  35    */
  36   typedef long medcalcNumber;
  37   const medcalcNumber NBCOMP_DEFAULT=-1;
  38
  39   interface MEDCalculator: SALOME::GenericObj
  40   {
  41     /*! Addition of the fields f1 and f2 ( f1+f2) */
  42     FieldHandler add(in FieldHandler f1, in FieldHandler f2)
  43       raises (SALOME::SALOME_Exception);
  44     /*! Substraction of the fields f1 and f2 (f1-f2) */
  45     FieldHandler sub(in FieldHandler f1, in FieldHandler f2)
  46       raises (SALOME::SALOME_Exception);
  47     /*! Multiplication of the fields f1 by f2 (f1*f2) */
  48     FieldHandler mul(in FieldHandler f1, in FieldHandler f2)
  49       raises (SALOME::SALOME_Exception);
  50     /*! Division of the fields f1 by f2 (f1/f2) */
  51     FieldHandler div(in FieldHandler f1, in FieldHandler f2)
  52       raises (SALOME::SALOME_Exception);
  53     /*! Power of the field f (f^power) */
  54     FieldHandler pow(in FieldHandler f, in long power)
  55       raises (SALOME::SALOME_Exception);
  56     /*! Linear transformation of the field f (factor*f+offset) */
  57     FieldHandler lin(in FieldHandler f, in double factor, in double offset)
  58       raises (SALOME::SALOME_Exception);
  59     /*! Duplication of the field f */
  60     FieldHandler dup(in FieldHandler f)
  61       raises (SALOME::SALOME_Exception);
  62
  63     /*! Creation of a field whose values are initialized with the specified double */
  64     /* FieldHandler ini(in double value) raises (SALOME::SALOME_Exception); */
  65
  66     /*! Transformation of the field f using a custom function */
  67     FieldHandler fct(in FieldHandler f, in string function, in medcalcNumber nbResComponents)
  68       raises (SALOME::SALOME_Exception);
  69
  70   };
  71 };
  72
  73 #endif // _MED_CALCULATOR_IDL_