Inheritance diagram for OpenViBE::Kernel::CKernelDesc:

Public Member Functions
IKernelContext *	createKernel (const CString &rApplicationName, const CString &rConfigurationFilename) override
	Creates the kernel itself. More...

IKernelContext *	createKernel (const IKernelContext &masterKernelCtx, const CString &applicationName, const CString &configFilename) override
	Creates the kernel itself and make it sub kernel of a master kernel. More...

void	releaseKernel (IKernelContext *pKernelContext) override
	Releases the kernel itself. 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	getVersion () const override
	Gets a version of the plugin. More...

Creation process
Textual plugin object description and information
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 ()

Member Function Documentation

◆ createKernel() [1/2]

IKernelContext * OpenViBE::Kernel::CKernelDesc::createKernel	(	const CString &	applicationName,
		const CString &	configFilename
	)

inlineoverridevirtual

Creates the kernel itself.

Parameters

applicationName	The name of the application requesting kernel creation (an configuration token will be created so the configuration file can be tweaked according to the targeted application).
configFilename	A bootstrap configuration file.

Returns: The created kernel.

This method creates the kernel itself and returns it.

Implements OpenViBE::Kernel::IKernelDesc.

◆ createKernel() [2/2]

IKernelContext * OpenViBE::Kernel::CKernelDesc::createKernel	(	const IKernelContext &	masterKernel,
		const CString &	applicationName,
		const CString &	configFilename
	)

inlineoverridevirtual

Creates the kernel itself and make it sub kernel of a master kernel.

Parameters

masterKernel	The master kernel.
applicationName	The name of the application requesting kernel creation (an configuration token will be created so the configuration file can be tweaked according to the targeted application).
configFilename	A bootstrap configuration file.

Returns: The created kernel.

This method creates the kernel itself and returns it.

Implements OpenViBE::Kernel::IKernelDesc.

◆ releaseKernel()

void OpenViBE::Kernel::CKernelDesc::releaseKernel ( IKernelContext * kernel )

inlineoverridevirtual

Releases the kernel itself.

Parameters

kernel The kernel to release.

This method releases an existing kernel.

Implements OpenViBE::Kernel::IKernelDesc.

◆ getName()

CString OpenViBE::Kernel::CKernelDesc::getName ( ) const

inlineoverridevirtual

Gets the plugin name.

Returns: The plugin name.

Default implementation simply returns empty string.

Reimplemented from OpenViBE::Kernel::IKernelDesc.

◆ getAuthorName()

CString OpenViBE::Kernel::CKernelDesc::getAuthorName ( ) const

inlineoverridevirtual

Gets the author name for this plugin.

Returns: The plugin name for this plugin.

Default implementation simply returns empty string.

Reimplemented from OpenViBE::Kernel::IKernelDesc.

◆ getAuthorCompanyName()

CString OpenViBE::Kernel::CKernelDesc::getAuthorCompanyName ( ) const

inlineoverridevirtual

Gets the author company name for this plugin.

Returns: The author company name for this plugin.

Default implementation simply returns empty string.

Reimplemented from OpenViBE::Kernel::IKernelDesc.

◆ getShortDescription()

CString OpenViBE::Kernel::CKernelDesc::getShortDescription ( ) const

inlineoverridevirtual

Gets a short description of the plugin.

Returns: A short description of the plugin.

Default implementation simply returns empty string.

Reimplemented from OpenViBE::Kernel::IKernelDesc.

◆ getDetailedDescription()

CString OpenViBE::Kernel::CKernelDesc::getDetailedDescription ( ) const

inlineoverridevirtual

Gets a detailed description of the plugin.

Returns: A detailed description of the plugin.

Default implementation simply returns empty string. You can use std::endl to have the description on several lines when needed.

Reimplemented from OpenViBE::Kernel::IKernelDesc.

◆ getVersion()

CString OpenViBE::Kernel::CKernelDesc::getVersion ( ) const

inlineoverridevirtual

Gets a version of the plugin.

Returns: The version of the plugin.

Default implementation simply returns empty string.

Reimplemented from OpenViBE::Kernel::IKernelDesc.

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ createKernel() [1/2]

◆ createKernel() [2/2]

◆ releaseKernel()

◆ getName()

◆ getAuthorName()

◆ getAuthorCompanyName()

◆ getShortDescription()

◆ getDetailedDescription()

◆ getVersion()