#include <IDianaMain.hpp>
Public Member Functions | |
| virtual Common::Collection::ICapeCollection * | GetParameters ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl) |
| virtual void | SetSimulationContext (Common::Identification::ICapeIdentification *simContextManager)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl) |
| virtual void | Initialize ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder) |
| virtual void | Terminate ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeBadInvOrder) |
| virtual Numeric::Solvers::Model::ICapeNumericModelManager * | GetModelManager ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) |
| virtual Numeric::Solvers::Solver::ICapeNumericSolverFactory * | GetSolverFactory ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) |
| virtual Numeric::Solvers::NLPTasks::ICapeNumericNLPTaskFactory * | GetNLPTaskFactory ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) |
| virtual IParallelEnv * | CreateParallelEnv ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) |
| virtual Diana::IDianaReporting * | CreateReportingInterface (const Common::Types::CapeString &strName)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) |
| virtual Diana::IDianaNLPSolverParallelInterface * | CreateNLPSolverParallelInterface (int argc, char *argv[], Common::Types::CapeString strLibraryName)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeUser) |
| virtual Common::Types::CapeString | GetVersion ()=0 throw (Common::Error::ECapeUnknown) |
| virtual void | Beep (int percent=0)=0 throw (Common::Error::ECapeUnknown) |
Detailed Description
Main singleton object, which evaluates also CmdArgs. It provides handles to the basic factories for models, solvers and reporters.
Member Function Documentation
| virtual Diana::IDianaNLPSolverParallelInterface* CreateNLPSolverParallelInterface | ( | int | argc, |
| char * | argv[], | ||
| Common::Types::CapeString | strLibraryName | ||
| ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeUser) [pure virtual] |
Creates parallel interface for specific solver
- Parameters:
-
strLibraryName name of the library, which contains report realization
| virtual IParallelEnv* CreateParallelEnv | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [pure virtual] |
Creates a parallel environement.
| virtual Diana::IDianaReporting* CreateReportingInterface | ( | const Common::Types::CapeString & | strName | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) [pure virtual] |
Creates a Reporter with specified name or from specified library name
| virtual Numeric::Solvers::Model::ICapeNumericModelManager* GetModelManager | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) [pure virtual] |
Returns a ModelManager.
Returns a NLPTaskFactory
| virtual Common::Collection::ICapeCollection* GetParameters | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl) [pure virtual] |
Returns an ICapeCollection interface. This interface will contain a collection of ICapeParameter interfaces. This method allows any client to access all the Cape Open Parameters exposed by a model component. If the model component does not support exposing its parameters, it should raise the ECapeNoImpl error, instead of returning a NULL reference or an empty Collection. But if the PMC supports parameters but has for this call no parameters, it should return a valid ICapeCollection reference exposing zero parameters.
Implements ICapeUtilities.
Referenced by DianaContinuation::DianaContinuation().
| virtual Numeric::Solvers::Solver::ICapeNumericSolverFactory* GetSolverFactory | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeFailedInitialisation) [pure virtual] |
Returns a SolverFactory
| virtual Common::Types::CapeString GetVersion | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Returns a version of the IDianaMain object
| virtual void Initialize | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder) [pure virtual] |
The environment will order the component to get initialized through this method. Any initialisation that could fail must be placed here. Initialize is guaranteed to be the first method called by the client (except low level methods such as class constructors or initialization persistence methods). Initialize has to be called once when the component is instantiated in a particular flowsheet. When the initialization fails, before signalling an error, the component must free all the resources that were allocated before the failure occurred. When the environment receives this error, it may not use the component anymore. The method terminate of the current interface must not either be called. Hence, the environment may only release the component through the middleware native mechanisms.
Implements ICapeUtilities.
| virtual void SetSimulationContext | ( | Common::Identification::ICapeIdentification * | simContextManager | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl) [pure virtual] |
Allows the environment to convey the component a reference to the former's simulation context. The simulation context will be environment objects which will expose a given set of Cape Open interfaces. Each of these interfaces will allow the component to call back the environment in order to benefit from its exposed services (such as creation of material templates, diagnostics or measurement unit conversion). If the component does not support accessing the simulation context, it is recommended to raise the ECapeNoImpl error.
- Parameters:
-
simContextManager the reference to the environment's simulation context class. For the component to use this class, this reference will have to be converted to each of the defined Cape Open Simulation Context interfaces.
Implements ICapeUtilities.
| virtual void Terminate | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeBadInvOrder) [pure virtual] |
The environment will order the component to get destroyed through this method. Any uninitialization that could fail must be placed here. Terminate is guaranteed to be the last method called by the client (except low level methods such as class destructors). Terminate may be called at any time, but may be only called once. When this method returns an error, the environment should report the user. However, after that the environment is not allowed to use the component anymore.
Implements ICapeUtilities.
The documentation for this class was generated from the following file:
