IBoxAlgorithmDesc Class Reference

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

Inheritance diagram for IBoxAlgorithmDesc:

List of all members.

Public Member Functions
Box prototype and description
virtual OpenViBE::boolean	getBoxPrototype (OpenViBE::Kernel::IBoxProto &rPrototype) const =0
	Gets the box prototype for this algorithm.
virtual OpenViBE::CString	getStockItemName (void) const
	Gets the stock item to display with this algorithm.
Box modification monitoring
virtual OpenViBE::Plugins::IBoxListener *	createBoxListener (void) const
	Creates a new box listener.
virtual void	releaseBoxListener (OpenViBE::Plugins::IBoxListener *pBoxListener) const
	Releases an existing box listener.

---

Detailed Description

Box algorithm plugin descriptor

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

Author:

Yann Renard (INRIA/IRISA)

Date:

2006-06-19

See also:

OpenViBE::Plugins::IBoxAlgorithm

Todo:

details about building new plugins

---

Member Function Documentation

virtual OpenViBE::boolean getBoxPrototype

(

OpenViBE::Kernel::IBoxProto &

rPrototype

)

const [pure virtual]

Gets the box prototype for this algorithm.

Parameters:

rPrototype

[out] : the box 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 corresponding box should look like (inputs/outputs/settings).

See also:

OpenViBE::Plugins::IBoxProto

virtual OpenViBE::CString getStockItemName

(

void

)

const [inline, virtual]

Gets the stock item to display with this algorithm.

Returns:

The stock item to display with this algorithm.

This item name will be used by the GUI to display a symbol to the algorithm list so a user can quickly find them in the list.

Default implementation returns empty string. If the item can not be found by name, or an empty string is returned, a default item will be displayed.

virtual OpenViBE::Plugins::IBoxListener* createBoxListener

(

void

)

const [inline, virtual]

Creates a new box listener.

Returns:

a new box listener

This function is called by the kernel when a box instance is created if any modification flag is set in its prototype. This box listener will be notified each time the box is modified.

See also:

OpenViBE::Kernel::IBoxProto

OpenViBE::Plugins::IBoxListener

virtual void releaseBoxListener

(

OpenViBE::Plugins::IBoxListener *

pBoxListener

)

const [inline, virtual]

Releases an existing box listener.

Parameters:

pBoxListener

[in] : the box listener to release

This function is called by the kernel as soon as it knows a box listener won't be used any more. In case this descriptor allocated some memory for this box listener, this memory can be freed safely, no more call will be done on this box listener.