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

Public Member Functions | |
Box prototype and description | |
virtual OpenViBE::boolean | getBoxPrototype (OpenViBE::Kernel::IBoxProto &rPrototype) const =0 |
Gets the box prototype for this algorithm. More... | |
virtual OpenViBE::CString | getStockItemName (void) const |
Gets the stock item to display with this algorithm. More... | |
Box modification monitoring | |
virtual OpenViBE::Plugins::IBoxListener * | createBoxListener (void) const |
Creates a new box listener. More... | |
virtual void | releaseBoxListener (OpenViBE::Plugins::IBoxListener *pBoxListener) const |
Releases an existing box listener. More... | |
![]() | |
virtual void | release (void)=0 |
Informs the plugin description it won't be used any more. More... | |
virtual OpenViBE::CIdentifier | getCreatedClass (void) const =0 |
Gives a tip on what this plugin descriptor is able to create. More... | |
virtual OpenViBE::CIdentifier | getCreatedClassIdentifier (void) const |
virtual OpenViBE::Plugins::IPluginObject * | create (void)=0 |
Creates the plugin object itself. More... | |
virtual OpenViBE::CString | getName (void) const |
Gets the plugin name. More... | |
virtual OpenViBE::CString | getAuthorName (void) const |
Gets the author name for this plugin. More... | |
virtual OpenViBE::CString | getAuthorCompanyName (void) const |
Gets the author company name for this plugin. More... | |
virtual OpenViBE::CString | getShortDescription (void) const |
Gets a short description of the plugin. More... | |
virtual OpenViBE::CString | getDetailedDescription (void) const |
Gets a detailed description of the plugin. More... | |
virtual OpenViBE::CString | getCategory (void) const |
Gets a basic category of the plugin. More... | |
virtual OpenViBE::CString | getVersion (void) const |
Gets the version of the plugin. More... | |
virtual OpenViBE::boolean | hasFunctionality (OpenViBE::Kernel::EPluginFunctionality ePF) const |
Tests whether the plugin has a given functionality. More... | |
virtual OpenViBE::boolean | hasLicenceType (OpenViBE::Kernel::ELicenseType eLT) const |
Tests the licence type for this plugin. More... | |
![]() | |
virtual OpenViBE::CIdentifier | getClassIdentifier (void) const =0 |
Returns the final class identifier of the concrete class. More... | |
virtual OpenViBE::boolean | isDerivedFromClass (const OpenViBE::CIdentifier &rClassIdentifier) const |
Checks if this object is compatible with a class identifier. More... | |
virtual OpenViBE::boolean | acceptVisitor (OpenViBE::IObjectVisitor &rObjectVisitor) |
Requests this object to accept a visitor. More... | |
Detailed Description
Box algorithm plugin descriptor
This class should be derived by any plugin developer in order to describe a specific OpenViBE box algorithm.
- Date
- 2006-06-19
- See Also
- OpenViBE::Plugins::IBoxAlgorithm
- Todo:
- details about building new plugins
Member Function Documentation
|
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
|
inlinevirtual |
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.
|
inlinevirtual |
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
|
inlinevirtual |
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.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
