IAlgorithmManager Class Referenceabstract
Manager for all kind of plugin algorithms. More...
Inherits IKernelObject.
Inherited by TKernelObject< OpenViBE::Kernel::IAlgorithmManager >.
Public Member Functions | |
virtual OpenViBE::CIdentifier | createAlgorithm (const OpenViBE::CIdentifier &rAlgorithmClassIdentifier)=0 |
Creates a new algorithm. More... | |
virtual OpenViBE::boolean | releaseAlgorithm (const OpenViBE::CIdentifier &rAlgorithmIdentifier)=0 |
Releases an existing algorithm. More... | |
virtual OpenViBE::boolean | releaseAlgorithm (OpenViBE::Kernel::IAlgorithmProxy &rAlgorithm)=0 |
Releases an existing algorithm. More... | |
virtual OpenViBE::Kernel::IAlgorithmProxy & | getAlgorithm (const OpenViBE::CIdentifier &rAlgorithmIdentifier)=0 |
Gets details on a specific algorithm. More... | |
virtual OpenViBE::CIdentifier | getNextAlgorithmIdentifier (const OpenViBE::CIdentifier &rPreviousIdentifier) const =0 |
Gets next algorithm identifier. More... | |
Detailed Description
Member Function Documentation
|
pure virtual |
Creates a new algorithm.
- Parameters
-
rAlgorithmClassIdentifier [out] : the class identifier of the newly created algorithm
- Returns
- true in case of success.
- OV_UndefinedIdentifier in case of error.
|
pure virtual |
Releases an existing algorithm.
- Parameters
-
rAlgorithmIdentifier [in] : the existing algorithm identifier
- Returns
- true in case of success.
- false in case of error.
|
pure virtual |
Releases an existing algorithm.
- Parameters
-
rAlgorithm [in] : the existing algorithm
- Returns
- true in case of success.
- false in case of error.
|
pure virtual |
Gets details on a specific algorithm.
- Parameters
-
rAlgorithmIdentifier [in] : the algorithm identifier which details should be returned
- Returns
- the corresponding algorithm reference.
- Warning
- Calling this function with a bad identifier causes a crash
|
pure virtual |
Gets next algorithm identifier.
- Parameters
-
rPreviousIdentifier [in] : The identifier for the preceeding algorithm
- Returns
- The identifier of the next algorithm in case of success.
-
OV_UndefinedIdentifier
on error.
- Note
- Giving
OV_UndefinedIdentifier
asrPreviousIdentifier
will cause this function to return the first algorithm identifier.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
