1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 #ifndef __GENERICSOLVER_GEN__
26 #define __GENERICSOLVER_GEN__
28 #include "SALOME_Component.idl"
29 #include "SALOMEDS.idl"
30 #include "SALOME_Exception.idl"
32 module GENERICSOLVER_ORB
35 typedef sequence<double> Point;
36 typedef SALOMEDS::ID ID;
38 interface GENERICSOLVER_Gen : Engines::Component, SALOMEDS::Driver
42 * @brief Prepare module for later computation.
44 * The Init method prepares the module for a series of computation
45 * based on a study case. The study case is a set of parameters that
46 * globally defines _ALL_ information needed to make a computation.
47 * When Init exits, the module is ready to run if a call to an hypothetical
48 * method Exec() (without any more argument) occurs.
50 * @return 0 if success, non zero if failure
51 * @param studyID the identifier of the study containing the study case
52 * @param entry the identifier of the study case within the study
53 * @param wrapperDescription a string containing the XML wrapper description
55 long Init(in long studyID, in ID entry, in string wrapperDescription)
56 raises (SALOME::SALOME_Exception);
59 * @brief Run the module with modified parameters
61 * The Run method realizes the computation with some parameters (within inPoint)
62 * altered compared to what Init set before. The result is put in outPoint.
64 * @return 0 if success, non zero if failure
65 * @param inPoint a vector of floating point values to be modified
66 * @param outPoint the result of the computation as a vector of floating point values
68 long Exec(in Point inPoint, out Point outPoint)
69 raises (SALOME::SALOME_Exception);
72 * @brief Cleanup everything that was previously set
74 * The Finalize method is in charge of cleaning everything that what set hitherto.
77 * @return 0 if success, non zero if failure
80 raises (SALOME::SALOME_Exception);