A kernel description. More...

Inheritance diagram for IKernelDesc:

Public Member Functions
Creation process
virtual OpenViBE::Kernel::IKernelContext *	createKernel (const OpenViBE::CString &rApplicationName, const OpenViBE::CString &rConfigurationFilename)=0
	Creates the kernel itself. More...

virtual OpenViBE::Kernel::IKernelContext *	createKernel (const OpenViBE::Kernel::IKernelContext &rMasterKernel, const OpenViBE::CString &rApplicationName, const OpenViBE::CString &rConfigurationFilename)=0
	Creates the kernel itself and make it sub kernel of a master kernel. More...

virtual void	releaseKernel (OpenViBE::Kernel::IKernelContext *pKernel)=0
	Releases the kernel itself. More...

Textual plugin object description and information
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	getVersion (void) const
	Gets the version of the plugin. More...

Public Member Functions inherited from IObject
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

A kernel description.

Author: Yann Renard (INRIA/IRISA)

Date: 2006-09-26

This interface is implemented to provide information on a specific kernel implementation and to create instances of this specific kernel implementation.

Member Function Documentation

virtual OpenViBE::Kernel::IKernelContext* createKernel	(	const OpenViBE::CString &	rApplicationName,
		const OpenViBE::CString &	rConfigurationFilename
	)

pure virtual

Creates the kernel itself.

Parameters

rApplicationName	[in] : 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)
rConfigurationFilename	[in] : a bootstrap configuration file

Returns: the created kernel.

This method creates the kernel itself and returns it.

Referenced by KernelFacade::loadKernel().

virtual OpenViBE::Kernel::IKernelContext* createKernel	(	const OpenViBE::Kernel::IKernelContext &	rMasterKernel,
		const OpenViBE::CString &	rApplicationName,
		const OpenViBE::CString &	rConfigurationFilename
	)

pure virtual

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

Parameters

rMasterKernel	[in] : the master kernel
rApplicationName	[in] : 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)
rConfigurationFilename	[in] : a bootstrap configuration file

Returns: the created kernel.

This method creates the kernel itself and returns it.

virtual void releaseKernel ( OpenViBE::Kernel::IKernelContext * pKernel )

pure virtual

Releases the kernel itself.

Parameters

pKernel [in] : the kernel to release

This method releases an existing kernel.

Referenced by KernelFacade::unloadKernel().

virtual OpenViBE::CString getName ( void ) const

inlinevirtual

Gets the plugin name.

Returns: The plugin name.