Descriptor of the box XDAWN Trainer. More...

#include <CBoxXDAWNTrainer.hpp>

Inheritance diagram for OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc:

Public Member Functions
void	release () override
	Informs the plugin description it won't be used any more. More...

CString	getName () const override
	Gets the plugin name. More...

CString	getAuthorName () const override
	Gets the author name for this plugin. More...

CString	getAuthorCompanyName () const override
	Gets the author company name for this plugin. More...

CString	getShortDescription () const override
	Gets a short description of the plugin. More...

CString	getDetailedDescription () const override
	Gets a detailed description of the plugin. More...

CString	getCategory () const override
	Gets a basic category of the plugin. More...

CString	getVersion () const override
	Gets the version of the plugin. More...

CString	getStockItemName () const override
	Gets the stock item to display with this algorithm. More...

CIdentifier	getCreatedClass () const override
	Gives a tip on what this plugin descriptor is able to create. More...

IPluginObject *	create () override
	Creates the plugin object itself. More...

bool	getBoxPrototype (Kernel::IBoxProto &prototype) const override
	Gets the box prototype for this algorithm. More...

Public Member Functions inherited from OpenViBE::Plugins::IBoxAlgorithmDesc
virtual IBoxListener *	createBoxListener () const
	Creates a new box listener. More...

virtual void	releaseBoxListener (IBoxListener *listener) const
	Releases an existing box listener. More...

Public Member Functions inherited from OpenViBE::Plugins::IPluginObjectDesc
virtual CIdentifier	getCreatedClassIdentifier () const

virtual bool	hasFunctionality (const EPluginFunctionality functionality) const
	Tests whether the plugin has a given functionality. More...

Public Member Functions inherited from OpenViBE::IObject
virtual CIdentifier	getClassIdentifier () const =0
	Returns the final class identifier of the concrete class. More...

virtual bool	isDerivedFromClass (const CIdentifier &classId) const
	Checks if this object is compatible with a class identifier. More...

virtual bool	acceptVisitor (IObjectVisitor &visitor)
	Requests this object to accept a visitor. More...

Additional Inherited Members
Protected Member Functions inherited from OpenViBE::IObject
virtual	~IObject ()

Detailed Description

Descriptor of the box XDAWN Trainer.

Member Function Documentation

◆ release()

void OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::release ( )

inlineoverridevirtual

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 OpenViBE::Plugins::IPluginObjectDesc.

◆ getName()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getName ( ) const

inlineoverridevirtual

Gets the plugin name.

Returns: The plugin name.

Default implementation simply returns empty string.

Reimplemented from OpenViBE::Plugins::IPluginObjectDesc.

◆ getAuthorName()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getAuthorName ( ) const

inlineoverridevirtual

Gets the author name for this plugin.

Returns: The author name for this plugin.

Default implementation simply returns "no name".

Reimplemented from OpenViBE::Plugins::IPluginObjectDesc.

◆ getAuthorCompanyName()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getAuthorCompanyName ( ) const

inlineoverridevirtual

Gets the author company name for this plugin.

Returns: The author company name for this plugin.

Default implementation simply returns "unknown".

Reimplemented from OpenViBE::Plugins::IPluginObjectDesc.

◆ getShortDescription()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getShortDescription ( ) const

inlineoverridevirtual

Gets a short description of the plugin.

Returns: A short description of the plugin.

Default implementation simply returns "unknown".

Reimplemented from OpenViBE::Plugins::IPluginObjectDesc.

◆ getDetailedDescription()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getDetailedDescription ( ) const

inlineoverridevirtual

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 OpenViBE::Plugins::IPluginObjectDesc.

◆ getCategory()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getCategory ( ) const

inlineoverridevirtual

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 OpenViBE::Plugins::IPluginObjectDesc.

◆ getVersion()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getVersion ( ) const

inlineoverridevirtual

Gets the version of the plugin.

Returns: the version of the plugin.

Default implementation simply returns "unknown".

Reimplemented from OpenViBE::Plugins::IPluginObjectDesc.

◆ getStockItemName()

CString OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getStockItemName ( ) const

inlineoverridevirtual

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 OpenViBE::Plugins::IBoxAlgorithmDesc.

◆ getCreatedClass()

CIdentifier OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getCreatedClass ( ) const

inlineoverridevirtual

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 OpenViBE::Plugins::IPluginObjectDesc.

◆ create()

IPluginObject * OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::create ( )

inlineoverridevirtual

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 OpenViBE::Plugins::IPluginObjectDesc.

◆ getBoxPrototype()

bool OpenViBE::Plugins::SignalProcessing::CBoxXDAWNTrainerDesc::getBoxPrototype ( Kernel::IBoxProto & prototype ) const

inlineoverridevirtual

Gets the box prototype for this algorithm.

Parameters

prototype [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: IBoxProto

Implements OpenViBE::Plugins::IBoxAlgorithmDesc.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ release()

◆ getName()

◆ getAuthorName()

◆ getAuthorCompanyName()

◆ getShortDescription()

◆ getDetailedDescription()

◆ getCategory()

◆ getVersion()

◆ getStockItemName()

◆ getCreatedClass()

◆ create()

◆ getBoxPrototype()