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

Manager for all kind of plugin algorithms.

Author
Yann Renard (INRIA/IRISA)
Date
2007-11-06
See Also
OpenViBE::Plugins::IAlgorithm

Member Function Documentation

virtual OpenViBE::CIdentifier createAlgorithm ( const OpenViBE::CIdentifier rAlgorithmClassIdentifier)
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.
virtual OpenViBE::boolean releaseAlgorithm ( const OpenViBE::CIdentifier rAlgorithmIdentifier)
pure virtual

Releases an existing algorithm.

Parameters
rAlgorithmIdentifier[in] : the existing algorithm identifier
Returns
true in case of success.
false in case of error.
virtual OpenViBE::boolean releaseAlgorithm ( OpenViBE::Kernel::IAlgorithmProxy rAlgorithm)
pure virtual

Releases an existing algorithm.

Parameters
rAlgorithm[in] : the existing algorithm
Returns
true in case of success.
false in case of error.
virtual OpenViBE::Kernel::IAlgorithmProxy& getAlgorithm ( const OpenViBE::CIdentifier rAlgorithmIdentifier)
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
virtual OpenViBE::CIdentifier getNextAlgorithmIdentifier ( const OpenViBE::CIdentifier rPreviousIdentifier) const
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 as rPreviousIdentifier will cause this function to return the first algorithm identifier.