OpenViBE::Kernel::IKernelContext Class Reference

Kernel context interface, gives access to each manager the kernel owns. More...

#include <IKernelContext.hpp>

Inheritance diagram for OpenViBE::Kernel::IKernelContext:

Public Member Functions
virtual bool	initialize (const char *const *=nullptr, size_t=0)
	Initializes the kernel context. More...
virtual bool	uninitialize ()
	Uninitializes the kernel context. More...
virtual IAlgorithmManager &	getAlgorithmManager () const =0
	Gets a reference on the kernel's algorithm manager. More...
virtual IConfigurationManager &	getConfigurationManager () const =0
	Gets a reference on the kernel's configuration manager. More...
virtual IPlayerManager &	getPlayerManager () const =0
	Gets a reference on the kernel's player manager. More...
virtual IPluginManager &	getPluginManager () const =0
	Gets a reference on the kernel's plugin manager. More...
virtual IMetaboxManager &	getMetaboxManager () const =0
	Gets a reference on the kernel's metabox manager. More...
virtual IKernelObjectFactory &	getKernelObjectFactory () const =0
	Gets a reference on the kernel's object factory. More...
virtual IScenarioManager &	getScenarioManager () const =0
	Gets a reference on the kernel's scenario manager. More...
virtual ITypeManager &	getTypeManager () const =0
	Gets a reference on the kernel's type manager. More...
virtual ILogManager &	getLogManager () const =0
	Gets a reference on the kernel's log manager. More...
virtual CErrorManager &	getErrorManager () const =0
	Gets a reference on the kernel's error manager. More...
virtual IKernelObjectFactory &	getObjectFactory () const
	Gets a reference on the kernel's object factory. 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

Kernel context interface, gives access to each manager the kernel owns.

This class simply provides access to each manager the kernel owns. This is the top level object that can be used by a custom OpenViBE application and this is the common object all kernel object have in order to access all the functionnalities.

See each manager's own documentation for more detail on a specific manager goal and usage.

See also

IKernelObject

Member Function Documentation

initialize()

virtual bool OpenViBE::Kernel::IKernelContext::initialize ( const char *const *  = nullptr, size_t  = 0  )

inlinevirtual

Initializes the kernel context.

Returns

true in case of success false otherwise.

Reimplemented in OpenViBE::Kernel::CKernelContextBridge, and OpenViBE::Kernel::CKernelContext.

uninitialize()

virtual bool OpenViBE::Kernel::IKernelContext::uninitialize ( )

inlinevirtual

Uninitializes the kernel context.

Returns

true in case of success false otherwise.

Reimplemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getAlgorithmManager()

virtual IAlgorithmManager & OpenViBE::Kernel::IKernelContext::getAlgorithmManager ( ) const

pure virtual

Gets a reference on the kernel's algorithm manager.

Returns

A reference on the kernel's algorithm manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getConfigurationManager()

virtual IConfigurationManager & OpenViBE::Kernel::IKernelContext::getConfigurationManager ( ) const

pure virtual

Gets a reference on the kernel's configuration manager.

Returns

A reference on the kernel's configuration manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getPlayerManager()

virtual IPlayerManager & OpenViBE::Kernel::IKernelContext::getPlayerManager ( ) const

pure virtual

Gets a reference on the kernel's player manager.

Returns

A reference on the kernel's player manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getPluginManager()

virtual IPluginManager & OpenViBE::Kernel::IKernelContext::getPluginManager ( ) const

pure virtual

Gets a reference on the kernel's plugin manager.

Returns

A reference on the kernel's plugin manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getMetaboxManager()

virtual IMetaboxManager & OpenViBE::Kernel::IKernelContext::getMetaboxManager ( ) const

pure virtual

Gets a reference on the kernel's metabox manager.

Returns

A reference on the kernel's metabox manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getKernelObjectFactory()

virtual IKernelObjectFactory & OpenViBE::Kernel::IKernelContext::getKernelObjectFactory ( ) const

pure virtual

Gets a reference on the kernel's object factory.

Returns

A reference on the kernel's object factory.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getScenarioManager()

virtual IScenarioManager & OpenViBE::Kernel::IKernelContext::getScenarioManager ( ) const

pure virtual

Gets a reference on the kernel's scenario manager.

Returns

A reference on the kernel's scenario manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getTypeManager()

virtual ITypeManager & OpenViBE::Kernel::IKernelContext::getTypeManager ( ) const

pure virtual

Gets a reference on the kernel's type manager.

Returns

A reference on the kernel's type manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getLogManager()

virtual ILogManager & OpenViBE::Kernel::IKernelContext::getLogManager ( ) const

pure virtual

Gets a reference on the kernel's log manager.

Returns

A reference on the kernel's log manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getErrorManager()

virtual CErrorManager & OpenViBE::Kernel::IKernelContext::getErrorManager ( ) const

pure virtual

Gets a reference on the kernel's error manager.

Returns

A reference on the kernel's error manager.

Implemented in OpenViBE::Kernel::CKernelContext, and OpenViBE::Kernel::CKernelContextBridge.

getObjectFactory()

virtual IKernelObjectFactory & OpenViBE::Kernel::IKernelContext::getObjectFactory ( ) const

inlinevirtual

Gets a reference on the kernel's object factory.

Returns

A reference on the kernel's object factory.

Deprecated:

Use the getKernelObjectFactory() instead.