idl/ATOMGEN.idl

   1 //  Copyright (C) 2007-2010  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.
  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21
  22 #ifndef __ATOMGEN_GEN__
  23 #define __ATOMGEN_GEN__
  24
  25 #include "SALOME_Component.idl"
  26 #include "SALOMEDS.idl"
  27 #include "SALOMEDS_Attributes.idl"
  28 #include "SALOME_Exception.idl"
  29
  30 module ATOMGEN_ORB
  31 {
  32   interface Atom
  33   {
  34     string getName();
  35     double getX();
  36     double getY();
  37     double getZ();
  38   };
  39
  40   interface Molecule
  41   {
  42     string getName();
  43     long getNbAtoms();
  44     Atom getAtom(in long theIndex);
  45   };
  46
  47   typedef sequence<Molecule> MoleculeList;
  48
  49   interface ATOMGEN_Gen : Engines::EngineComponent, SALOMEDS::Driver
  50   {
  51     /*!
  52       Set active study
  53      */
  54     void     setCurrentStudy(in SALOMEDS::Study theStudy);
  55
  56     /*!
  57       Import atomic data from external XML file
  58      */
  59     boolean  importXmlFile(in string theFileName);
  60
  61     /*!
  62       Export atomic data to external XML file
  63      */
  64     boolean  exportXmlFile(in string theFileName);
  65
  66     /*!
  67       Perform action on the atomic data
  68      */
  69     boolean processData(in MoleculeList theData);
  70
  71     /*!
  72      Return the data (list of molecules) for given study
  73      */
  74      MoleculeList getData(in long studyID);
  75   };
  76 };
  77
  78 #endif