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