-// Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
-//
-// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+// Copyright (C) 2009-2012 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
module GENERICSOLVER_ORB
{
- typedef sequence<double> Point;
- typedef SALOMEDS::ID ID;
- typedef sequence<string> VarList;
- typedef Engines::fileBlock pyobj;
-
- interface GENERICSOLVER_Gen : Engines::Component, SALOMEDS::Driver
+ 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);
-
-
- /**
- * @brief Initialize the component with the deterministic variables and the lists of
- * probabilistic variables.
- *
- * The InitWithVarList method prepares the component for a series of computation
- * with the method ExecWithVarList. It stores the deterministic variables and the
- * lists of input and output variables to identify them in future calls to
- * ExecWithVarList.
- *
- * @param inputVarList a list of strings containing the names of the input
- * variables in the same order as in subsequent calls to
- * ExecWithVarList.
- * @param outputVarList a list of strings containing the names of the output
- * variables in the same order as they should be returned
- * in subsequent calls to ExecWithVarList.
- * @param deterministicVars a python dictionary containing the deterministic
- * variables (mapping variable names to variable values)
- */
- void InitWithVarList(in VarList inputVarList, in VarList outputVarList, in pyobj deterministicVars)
- raises (SALOME::SALOME_Exception);
-
- /**
- * @brief Execute a computation with a given sample of variables.
- *
- * The ExecWithVarList method realizes the computation with some parameters (within
- * inPoint) corresponding to the variables set previously with the method
- * InitWithVarList. The result is put in outPoint in the order specified by
- * outputVarList of InitWithVarList method.
- *
- * @param inPoint a vector of floating point values to be evaluated
- * @param outPoint the result of the computation as a vector of floating point values
- */
- void ExecWithVarList(in Point inPoint, out Point outPoint)
- raises (SALOME::SALOME_Exception);
-
};
};
