X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=idl%2FPYCALCULATOR_Gen.idl;h=4c0e468997bd7608db6ee40172b34592cf099f56;hb=3c8defa6c3da0df43338e9fb387d9d2c547f1628;hp=1d8edbd6f1b8a3251c3cbee33eff3de7f82f3176;hpb=6f68cfa2ee0b412d819e3f60740c8a4922c36ab0;p=samples%2Fpycalculator.git diff --git a/idl/PYCALCULATOR_Gen.idl b/idl/PYCALCULATOR_Gen.idl index 1d8edbd..4c0e468 100644 --- a/idl/PYCALCULATOR_Gen.idl +++ b/idl/PYCALCULATOR_Gen.idl @@ -1,11 +1,14 @@ -// Copyright (C) 2005 CEA/DEN, EDF R&D +// Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE +// +// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License. // -// This library is distributed in the hope that it will be useful +// This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. @@ -14,36 +17,80 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // -// See http://www.salome-platform.org/ +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // -//============================================================================= -// File : Calculator.idl -// Created : jeu nov 08 12:08:17 CEST 2001 -// Author : Laurent DADA CEA -// Project : SALOME -// $Header$ -//============================================================================= + +//============================================================================ +// File : PYCALCULATOR.idl +// Author : Vadim SANDLER, OPEN CASCADE S.A.S. (vadim.sandler@opencascade.com) +//============================================================================ #ifndef PYCALCULATOR_IDL #define PYCALCULATOR_IDL #include "SALOME_Component.idl" -#include "MED.idl" +#include "MEDCouplingCorbaServant.idl" +/*! + \ingroup examples + This package contains the interface for %PYCALCULATOR component + as an example in %SALOME application. +*/ module PYCALCULATOR_ORB { -interface PYCALCULATOR_Gen : Engines::Component -{ - - SALOME_MED::FIELDDOUBLE Add(in SALOME_MED::FIELDDOUBLE field1, in SALOME_MED::FIELDDOUBLE field2); - SALOME_MED::FIELDDOUBLE Mul(in SALOME_MED::FIELDDOUBLE field1, in double x1); - SALOME_MED::FIELDDOUBLE Constant(in SALOME_MED::FIELDDOUBLE field1, in double x1); - void writeMEDfile(in SALOME_MED::FIELDDOUBLE field1, in string fileName); + /*! + \brief Interface of the %PYCALCULATOR component + */ + interface PYCALCULATOR_Gen : Engines::EngineComponent + { + /*! + \brief Clone field. + \param field a field + \return a field which is a copy of \a field + */ + SALOME_MED::MEDCouplingFieldDoubleCorbaInterface + Clone(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field); -}; -}; + /*! + \brief Add two fields. + \param field1 first field + \param field2 second field + \return a field which is result of addition of \a field1 and \a field2 + */ + SALOME_MED::MEDCouplingFieldDoubleCorbaInterface + Add(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field1, + in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field2); + /*! + \brief Multiply two fields. + \param field1 first field + \param field2 second field + \return a field which is result of multiplication of \a field1 and \a field2 + */ + SALOME_MED::MEDCouplingFieldDoubleCorbaInterface + Mul(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field1, + in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field2); + /*! + \brief Add a constant to a field. + \param field a field + \param val a constant + \return a field which is result of addition of \a val to \a field + */ + SALOME_MED::MEDCouplingFieldDoubleCorbaInterface + AddConstant(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field, + in double val); + /*! + \brief Multiply a field to a constant. + \param field a field + \param val a constant + \return a field which is result of multiplication of \a field to \a val + */ + SALOME_MED::MEDCouplingFieldDoubleCorbaInterface + MulConstant(in SALOME_MED::MEDCouplingFieldDoubleCorbaInterface field, + in double val); + }; +}; #endif