IPluginObject Class Reference

Base class for plugin objectThis class is the base class for all the concrete plugin classes that extend the OpenViBE platform. It comes with several basic functions each plugin should have in order to work in the OpenViBE platform. More...

Inheritance diagram for IPluginObject:
IObject IAlgorithm IBoxAlgorithm

List of all members.

Public Member Functions

Memory management
virtual void release (void)=0
 Informs the plugin object it won't be used anymore.

Detailed Description

Base class for plugin object

This class is the base class for all the concrete plugin classes that extend the OpenViBE platform. It comes with several basic functions each plugin should have in order to work in the OpenViBE platform.

Author:
Yann Renard (INRIA/IRISA)
Date:
2006-06-19 Each plugin class comes with a plugin descriptor class (which you can write deriving the IPluginObjectDesc interface).
See also:
IBoxAlgorithm
IScenarioImporter
IScenarioExporter
IPluginObjectDesc
Todo:
details about building new plugins

Member Function Documentation

virtual void release ( void  ) [pure virtual]

Informs the plugin object it won't be used anymore.

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