CBoxAlgorithmStreamedMatrixSwitchDesc Class Reference

Descriptor of the box Streamed Matrix Switch. More...

Inheritance diagram for CBoxAlgorithmStreamedMatrixSwitchDesc:

List of all members.

Public Member Functions
virtual void	release (void)
	Informs the plugin description it won't be used any more.
virtual OpenViBE::CString	getName (void) const
	Gets the plugin name.
virtual OpenViBE::CString	getAuthorName (void) const
	Gets the author name for this plugin.
virtual OpenViBE::CString	getAuthorCompanyName (void) const
	Gets the author company name for this plugin.
virtual OpenViBE::CString	getShortDescription (void) const
	Gets a short description of the plugin.
virtual OpenViBE::CString	getDetailedDescription (void) const
	Gets a detailed description of the plugin.
virtual OpenViBE::CString	getCategory (void) const
	Gets a basic category of the plugin.
virtual OpenViBE::CString	getVersion (void) const
	Gets the version of the plugin.
virtual OpenViBE::CString	getStockItemName (void) const
	Gets the stock item to display with this algorithm.
virtual OpenViBE::CIdentifier	getCreatedClass (void) const
	Gives a tip on what this plugin descriptor is able to create.
virtual OpenViBE::Plugins::IPluginObject *	create (void)
	Creates the plugin object itself.
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.
virtual OpenViBE::boolean	getBoxPrototype (OpenViBE::Kernel::IBoxProto &rBoxAlgorithmPrototype) const
	Gets the box prototype for this algorithm.

---

Detailed Description

Descriptor of the box Streamed Matrix Switch.

Author:

Laurent Bonnet (INRIA)

Date:

Thu May 12 18:02:05 2011

---

Member Function Documentation

virtual void release

(

void

)

[inline, virtual]

Informs the plugin description it won't be used any more.

This is called by the OpenViBE platform to inform the plugin description it is not useful anymore. The plugin can chose whether to delete itself or to stay in memory until it decides it is ok to be deleted. However, the OpenViBE platform will not call any of the plugin functions after release is called.

Implements IPluginObjectDesc.

virtual OpenViBE::CString getName

(

void

)

const [inline, virtual]

Gets the plugin name.

Returns:

The plugin name.

Default implementation simply returns empty string.

Reimplemented from IPluginObjectDesc.

virtual OpenViBE::CString getAuthorName

(

void

)

const [inline, virtual]

Gets the author name for this plugin.

Returns:

The author name for this plugin.

Default implementation simply returns "no name".

Reimplemented from IPluginObjectDesc.

virtual OpenViBE::CString getAuthorCompanyName

(

void

)

const [inline, virtual]

Gets the author company name for this plugin.

Returns:

The author company name for this plugin.

Default implementation simply returns "unknown".

Reimplemented from IPluginObjectDesc.

virtual OpenViBE::CString getShortDescription

(

void

)

const [inline, virtual]

Gets a short description of the plugin.

Returns:

A short description of the plugin.

Default implementation simply returns "unknown".

Reimplemented from IPluginObjectDesc.

virtual OpenViBE::CString getDetailedDescription

(

void

)

const [inline, virtual]

Gets a detailed description of the plugin.

Returns:

A detailed description of the plugin.

Default implementation simply returns empty string.

Note:

You can use std::endl to have the description on several lines when needed.

Reimplemented from IPluginObjectDesc.

virtual OpenViBE::CString getCategory

(

void

)

const [inline, virtual]

Gets a basic category of the plugin.

Returns:

the category tokens of the plugin

The tokens should be separated with '/' characters in order to create sub categories.

Default implementation returns "unknown".

Reimplemented from IPluginObjectDesc.

virtual OpenViBE::CString getVersion

(

void

)

const [inline, virtual]

Gets the version of the plugin.

Returns:

the version of the plugin.

Default implementation simply returns "unknown".

Reimplemented from IPluginObjectDesc.

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.

Reimplemented from IBoxAlgorithmDesc.

virtual OpenViBE::CIdentifier getCreatedClass

(

void

)

const [inline, virtual]

Gives a tip on what this plugin descriptor is able to create.

This may inform the OpenViBE platform about what kind of plugin can be created using this plugin descriptor. It should return the concrete class identifier of the plugin object itself.

Implements IPluginObjectDesc.

virtual OpenViBE::Plugins::IPluginObject* create

(

void

)

[inline, virtual]

Creates the plugin object itself.

Returns:

the created object.

This method creates the plugin object itself and returns it with the lowest level interface. The OpenVIBE platform then uses the IObject::isDerivedFromClass method to use the plugin correctly.

Implements IPluginObjectDesc.

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

Reimplemented from IBoxAlgorithmDesc.

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.

Reimplemented from IBoxAlgorithmDesc.

virtual OpenViBE::boolean getBoxPrototype

(

OpenViBE::Kernel::IBoxProto &

rPrototype

)

const [inline, 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

Implements IBoxAlgorithmDesc.

References IBoxProto::addFlag(), IBoxProto::addInput(), IBoxProto::addOutput(), and IBoxProto::addSetting().