idl/ATOMSOLV.idl

   1 // Copyright (C) 2007-2014  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 #ifndef __ATOMSOLV_GEN__
  21 #define __ATOMSOLV_GEN__
  22
  23 #include "SALOME_Component.idl"
  24 #include "SALOME_Exception.idl"
  25 #include "ATOMGEN.idl"
  26
  27
  28 /*!  \ingroup EXAMPLES
  29
  30 This package contains the interface ATOMSOLV_ORB used
  31 for  %ATOMSOLV component as an example in %SALOME application.
  32 */
  33 module ATOMSOLV_ORB
  34 {
  35   /*!
  36     New type for Molecule with a double coefficient (temperature)
  37    */
  38   struct TMolecule
  39   {
  40     ATOMGEN_ORB::Molecule molecule;
  41     double temperature;
  42   };
  43
  44   typedef sequence<TMolecule> TMoleculeList;
  45
  46   /*! \brief Interface of the %ATOMSOLV component
  47    */
  48   interface ATOMSOLV_Gen : Engines::EngineComponent
  49   {
  50     /*!
  51       Set internal data structure from external source (ATOMGEN component, for example).
  52      */
  53     boolean setData( in long studyID, in TMoleculeList theData );
  54
  55     /*!
  56       Get internal data structure
  57      */
  58     boolean getData( in long studyID, out TMoleculeList outData );
  59
  60     /*!
  61       Perform action on the atomic data
  62      */
  63     boolean processData( in long studyID );
  64   };
  65 };
  66
  67 #endif