1 // Copyright (C) 2009-2011 EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 #ifndef __GENERICSOLVER_GEN__
23 #define __GENERICSOLVER_GEN__
25 #include "SALOME_Component.idl"
26 #include "SALOMEDS.idl"
27 #include "SALOME_Exception.idl"
29 module GENERICSOLVER_ORB
32 typedef sequence<double> Point;
33 typedef SALOMEDS::ID ID;
35 interface GENERICSOLVER_Gen : Engines::EngineComponent, SALOMEDS::Driver
39 * @brief Prepare module for later computation.
41 * The Init method prepares the module for a series of computation
42 * based on a study case. The study case is a set of parameters that
43 * globally defines _ALL_ information needed to make a computation.
44 * When Init exits, the module is ready to run if a call to an hypothetical
45 * method Exec() (without any more argument) occurs.
47 * @return 0 if success, non zero if failure
48 * @param studyID the identifier of the study containing the study case
49 * @param entry the identifier of the study case within the study
50 * @param wrapperDescription a string containing the XML wrapper description
52 long Init(in long studyID, in ID entry, in string wrapperDescription)
53 raises (SALOME::SALOME_Exception);
56 * @brief Run the module with modified parameters
58 * The Run method realizes the computation with some parameters (within inPoint)
59 * altered compared to what Init set before. The result is put in outPoint.
61 * @return 0 if success, non zero if failure
62 * @param inPoint a vector of floating point values to be modified
63 * @param outPoint the result of the computation as a vector of floating point values
65 long Exec(in Point inPoint, out Point outPoint)
66 raises (SALOME::SALOME_Exception);
69 * @brief Cleanup everything that was previously set
71 * The Finalize method is in charge of cleaning everything that what set hitherto.
74 * @return 0 if success, non zero if failure
77 raises (SALOME::SALOME_Exception);