IAlgorithmDesc Class Reference
[Extension mechanism]

Algorithm plugin descriptor

This class should be derived by any plugin developper in order to describe a specific OpenViBE algorithm. More...

Inheritance diagram for IAlgorithmDesc:

List of all members.

Public Member Functions
virtual OpenViBE::boolean	getAlgorithmPrototype (OpenViBE::Kernel::IAlgorithmProto &rAlgorithmPrototype) const =0
	Gets the prototype for this algorithm.

---

Detailed Description

Algorithm plugin descriptor

This class should be derived by any plugin developper in order to describe a specific OpenViBE algorithm.

Author:

Yann Renard (INRIA/IRISA)

Date:

2007-11-06

See also:

OpenViBE::Plugins::IAlgorithm

Todo:

details about building new plugins

---

Member Function Documentation

virtual OpenViBE::boolean getAlgorithmPrototype

(

OpenViBE::Kernel::IAlgorithmProto &

rAlgorithmPrototype

)

const [pure virtual]

Gets the prototype for this algorithm.

Parameters:

rAlgorithmPrototype

[out] : the prototype to fill

Returns:

true in case of success false in other cases.

When this function is called by the OpenViBE platform, the plugin descriptor should fill in the structure to let the OpenViBE platform know what the algorithm should look like (inputs/outputs/triggers).

See also:

OpenViBE::Plugins::IAlgorithmProto