idl/PYCALCULATOR_Gen.idl

   1 // Copyright (C) 2007-2014  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 //============================================================================
  24 // File   : PYCALCULATOR.idl
  25 // Author : Vadim SANDLER, OPEN CASCADE S.A.S. (vadim.sandler@opencascade.com)
  26 //============================================================================
  27
  28 #ifndef PYCALCULATOR_IDL
  29 #define PYCALCULATOR_IDL
  30
  31 #include "SALOME_Component.idl"
  32 #include "MEDCouplingCorbaServant.idl"
  33
  34 /*!
  35   \ingroup examples
  36   This package contains the interface for %PYCALCULATOR component
  37   as an example in %SALOME application.
  38 */
  39
  40 module PYCALCULATOR_ORB {
  41
  42   /*!
  43     \brief Interface of the %PYCALCULATOR component
  44   */
  45   interface PYCALCULATOR_Gen : Engines::EngineComponent
  46   {
  47     /*!
  48       \brief Clone field.
  49       \param field a field
  50       \return a field which is a copy of \a field
  51     */
  52     SALOME_MED::MEDCouplingFieldDoubleCorbaInterface
  53               Clone(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field);
  54
  55     /*!
  56       \brief Add two fields.
  57       \param field1 first field
  58       \param field2 second field
  59       \return a field which is result of addition of \a field1 and \a field2
  60     */
  61     SALOME_MED::MEDCouplingFieldDoubleCorbaInterface
  62               Add(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field1,
  63                   in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field2);
  64
  65     /*!
  66       \brief Multiply two fields.
  67       \param field1 first field
  68       \param field2 second field
  69       \return a field which is result of multiplication of \a field1 and \a field2
  70     */
  71     SALOME_MED::MEDCouplingFieldDoubleCorbaInterface
  72               Mul(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field1,
  73                   in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field2);
  74
  75     /*!
  76       \brief Add a constant to a field.
  77       \param field a field
  78       \param val a constant
  79       \return a field which is result of addition of \a val to \a field
  80     */
  81     SALOME_MED::MEDCouplingFieldDoubleCorbaInterface
  82               AddConstant(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field,
  83                           in double val);
  84     /*!
  85       \brief Multiply a field to a constant.
  86       \param field a field
  87       \param val a constant
  88       \return a field which is result of multiplication of \a field to \a val
  89     */
  90     SALOME_MED::MEDCouplingFieldDoubleCorbaInterface
  91               MulConstant(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field,
  92                           in double val);
  93   };
  94 };
  95
  96 #endif