The CMetaboxObjectDesc virtual BoxAlgorithmDesc for metaboxes. More...
Inherits IMetaboxObjectDesc.
Public Member Functions | |
virtual void | release (void) |
Informs the plugin description it won't be used any more. 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::CString | getStockItemName (void) const |
Gets the stock item to display with this algorithm. More... | |
virtual OpenViBE::CString | getAddedSoftwareVersion (void) const |
Gets the version of the software in the one the plugin was added. More... | |
virtual OpenViBE::CString | getUpdatedSoftwareVersion (void) const |
Gets the version of the software in the one the plugin was last updated. More... | |
virtual OpenViBE::CIdentifier | getCreatedClass (void) const |
Gives a tip on what this plugin descriptor is able to create. More... | |
virtual OpenViBE::Plugins::IPluginObject * | create (void) |
Creates the plugin object itself. More... | |
virtual bool | getBoxPrototype (OpenViBE::Kernel::IBoxProto &rBoxAlgorithmPrototype) const |
Gets the box prototype for this algorithm. More... | |
Detailed Description
The CMetaboxObjectDesc virtual BoxAlgorithmDesc for metaboxes.
This class provides a virtual algorithm descriptor for metaboxes. Each metabox-scenario will result in one of these descriptors. The prototype is created from scenario inputs, outputs and settings.
Variables such as name, author etc are pulled from scenario information.
Member Function Documentation
|
inlinevirtual |
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.
|
inlinevirtual |
Gets the plugin name.
- Returns
- The plugin name.
Default implementation simply returns empty string.
Reimplemented from IPluginObjectDesc.
|
inlinevirtual |
Gets the author name for this plugin.
- Returns
- The author name for this plugin.
Default implementation simply returns "no name".
Reimplemented from IPluginObjectDesc.
|
inlinevirtual |
Gets the author company name for this plugin.
- Returns
- The author company name for this plugin.
Default implementation simply returns "unknown".
Reimplemented from IPluginObjectDesc.
|
inlinevirtual |
Gets a short description of the plugin.
- Returns
- A short description of the plugin.
Default implementation simply returns "unknown".
Reimplemented from IPluginObjectDesc.
|
inlinevirtual |
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.
|
inlinevirtual |
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.
|
inlinevirtual |
Gets the version of the plugin.
- Returns
- the version of the plugin.
Default implementation simply returns "unknown".
Reimplemented from IPluginObjectDesc.
|
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.
- Deprecated:
- This method was used when visualisation was handled within the Kernel. This is kept for backward compatibility. Such features should now be handled at application level.
Reimplemented from IBoxAlgorithmDesc.
|
inlinevirtual |
Gets the version of the software in the one the plugin was added.
- Returns
- the version of the software in the one the plugin was added.
- Return values
-
unknown if not redefined
- See also
- getSoftwareComponent
Reimplemented from IPluginObjectDesc.
|
inlinevirtual |
Gets the version of the software in the one the plugin was last updated.
- Returns
- the version of the software in the one the plugin was last updated
- Return values
-
unknown if not redefined
- See also
- getSoftwareComponent
Reimplemented from IPluginObjectDesc.
|
inlinevirtual |
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.
|
inlinevirtual |
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.
References CMetaboxObjectDesc::getBoxPrototype().
|
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::addInput(), IBoxProto::addOutput(), and IBoxProto::addSetting().
Referenced by CMetaboxObjectDesc::create().
Generated on Tue Jun 26 2012 15:25:54 for Documentation by 1.7.4