Salome HOME
Increment version: 9.8.0
[samples/genericsolver.git] / idl / GENERICSOLVER_Gen.idl
index 1f076915ec6f404ca29147af2e5b783106603655..89935652460875b60f5b6cb4fdf020fc8f700bf5 100644 (file)
@@ -1,22 +1,20 @@
-//  Copyright (C) 2009-2010 EDF R&D
+// Copyright (C) 2009-2021  EDF R&D
 //
-//  This library is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU Lesser General Public
-//  License as published by the Free Software Foundation; either
-//  version 2.1 of the License.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
 //
-//  This library is distributed in the hope that it will be useful,
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//  Lesser General Public License for more details.
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
-//  You should have received a copy of the GNU Lesser General Public
-//  License along with this library; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-//
-//  $Id$
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef __GENERICSOLVER_GEN__
 module GENERICSOLVER_ORB
 {
 
-  typedef sequence<double> Point;
-  typedef SALOMEDS::ID ID;
-
   interface GENERICSOLVER_Gen : Engines::EngineComponent, SALOMEDS::Driver
   {
 
-    /**
-     * @brief Prepare module for later computation.
-     *
-     * The Init method prepares the module for a series of computation
-     * based on a study case. The study case is a set of parameters that
-     * globally defines _ALL_ information needed to make a computation.
-     * When Init exits, the module is ready to run if a call to an hypothetical
-     * method Exec() (without any more argument) occurs.
-     *
-     * @return                   0 if success, non zero if failure
-     * @param studyID            the identifier of the study containing the study case
-     * @param entry              the identifier of the study case within the study
-     * @param wrapperDescription a string containing the XML wrapper description
-     */
-    long Init(in long studyID, in ID entry, in string wrapperDescription)
-      raises (SALOME::SALOME_Exception);
-
-    /**
-     * @brief Run the module with modified parameters
-     *
-     * The Run method realizes the computation with some parameters (within inPoint)
-     * altered compared to what Init set before. The result is put in outPoint.
-     *
-     * @return          0 if success, non zero if failure
-     * @param inPoint   a vector of floating point values to be modified
-     * @param outPoint  the result of the computation as a vector of floating point values
-     */
-    long Exec(in Point inPoint, out Point outPoint)
-      raises (SALOME::SALOME_Exception);
-
-    /**
-     * @brief Cleanup everything that was previously set
-     *
-     * The Finalize method is in charge of cleaning everything that what set hitherto.
-     * It may be empty.
-     *
-     * @return          0 if success, non zero if failure
-     */
-    long Finalize()
-      raises (SALOME::SALOME_Exception);
-
   };
 };