IMetaboxManager Class Reference

Metabox manager. More...

Inheritance diagram for IMetaboxManager:

Public Member Functions
Metabox modules/descriptors management
virtual bool	addMetaboxesFromFiles (const OpenViBE::CString &fileNameWildCard)=0
	Loads new metaboxes module file(s) More...
virtual OpenViBE::CIdentifier	getNextMetaboxObjectDescIdentifier (const OpenViBE::CIdentifier &previousIdentifier) const =0
	Gets next metabox object descriptor identifier. More...
virtual const OpenViBE::Plugins::IPluginObjectDesc *	getMetaboxObjectDesc (const OpenViBE::CIdentifier &metaboxIdentifier) const =0
	Gets details on a specific metabox object descriptor. More...
virtual void	setMetaboxObjectDesc (const OpenViBE::CIdentifier &metaboxIdentifier, OpenViBE::Plugins::IPluginObjectDesc *metaboxDescriptor)=0
	Sets details on a specific metabox object descriptor. More...
virtual OpenViBE::CString	getMetaboxFilePath (const OpenViBE::CIdentifier &metaboxIdentifier) const =0
	Gets the path of the scenario of a specific metabox. More...
virtual void	setMetaboxFilePath (const OpenViBE::CIdentifier &metaboxIdentifier, const OpenViBE::CString &filePath)=0
	Sets the path of the scenario of a specific metabox. More...
virtual OpenViBE::CIdentifier	getMetaboxHash (const OpenViBE::CIdentifier &metaboxIdentifier) const =0
	Gets the hash of the metabox. More...
virtual void	setMetaboxHash (const OpenViBE::CIdentifier &metaboxIdentifier, const OpenViBE::CIdentifier &hash)=0
	Sets the hash of the metabox. 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

Metabox manager.

Author

Thierry Gaugry (INRIA/Mensia)

Date

2017-04-12

The metabox manager is in charge of loading/unloading metaboxes modules (defined in OV_ScenarioImportContext_OnLoadMetaboxImport import context) containing OpenViBE metaboxes. It also provides functions in order to list metabox descriptors, create or release metabox objects...

Member Function Documentation

virtual bool addMetaboxesFromFiles ( const OpenViBE::CString &  fileNameWildCard )

pure virtual

Loads new metaboxes module file(s)

Parameters

[in]

rFileNameWildCard

: a wild card with the file(s) to search metaboxes in

Returns

true in case of success.

false in case of error.

Referenced by KernelFacade::loadKernel().

virtual OpenViBE::CIdentifier getNextMetaboxObjectDescIdentifier ( const OpenViBE::CIdentifier &  previousIdentifier ) const

pure virtual

Gets next metabox object descriptor identifier.

Parameters

[in]

previousIdentifier

: The identifier for the preceeding metabox object descriptor

Returns

The identifier of the next metabox object descriptor in case of success.

Return values

virtual const OpenViBE::Plugins::IPluginObjectDesc* getMetaboxObjectDesc ( const OpenViBE::CIdentifier &  metaboxIdentifier ) const

pure virtual

Gets details on a specific metabox object descriptor.

Parameters

[in]

metaboxIdentifier

: the metabox object descriptor identifier which details should be returned

Returns

the corresponding metabox object descriptor pointer.

virtual void setMetaboxObjectDesc ( const OpenViBE::CIdentifier &  metaboxIdentifier, OpenViBE::Plugins::IPluginObjectDesc *  metaboxDescriptor  )

pure virtual

Sets details on a specific metabox object descriptor.

Parameters

[in]	metaboxIdentifier	: the metabox object descriptor identifier
[in]	metaboxDescriptor	: the metabox object descriptor

virtual OpenViBE::CString getMetaboxFilePath ( const OpenViBE::CIdentifier &  metaboxIdentifier ) const

pure virtual

Gets the path of the scenario of a specific metabox.

Parameters

[in]

metaboxIdentifier

: the metabox object descriptor identifier which path should be returned

Returns

the path to the scenario file of the metabox.

virtual void setMetaboxFilePath ( const OpenViBE::CIdentifier &  metaboxIdentifier, const OpenViBE::CString &  filePath  )

pure virtual

Sets the path of the scenario of a specific metabox.

Parameters

[in]	metaboxIdentifier	: the metabox object descriptor identifier
[in]	filePath	: the metabox scenario path

virtual OpenViBE::CIdentifier getMetaboxHash ( const OpenViBE::CIdentifier &  metaboxIdentifier ) const

pure virtual

Gets the hash of the metabox.

Parameters

[in]

metaboxIdentifier

: the metabox object descriptor identifier which hash should be returned

Returns

the hash of the metabox.

virtual void setMetaboxHash ( const OpenViBE::CIdentifier &  metaboxIdentifier, const OpenViBE::CIdentifier &  hash  )

pure virtual

Sets the hash of the metabox.

Parameters

[in]	metaboxIdentifier	: the metabox object descriptor identifier
[in]	hash	: the metabox hash