IBoxAlgorithmContext Class Reference

Specific context to use for box algorithm pluginsThis 'context' is given by the player to an algorithm plugin so it has all the necessary tools to work. This algorithm context mainly consists in getting other contexts which could be defined and used more generically (such as the box interface or a global player interface for example). More...

Inheritance diagram for IBoxAlgorithmContext:

Public Member Functions
virtual const OpenViBE::Kernel::IBox *	getStaticBoxContext (void)=0
	Gets the static context of the box corresponding to the algorithm. More...
virtual OpenViBE::Kernel::IBoxIO *	getDynamicBoxContext (void)=0
	Gets the dynamic context of the box corresponding to the algorithm. More...
virtual OpenViBE::Kernel::IPlayerContext *	getPlayerContext (void)=0
	Gets the player context. More...
virtual OpenViBE::boolean	markAlgorithmAsReadyToProcess (void)=0
	Marks the algorithm as 'ready to process' so its process function is called by the kernel. 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

Specific context to use for box algorithm plugins

This 'context' is given by the player to an algorithm plugin so it has all the necessary tools to work. This algorithm context mainly consists in getting other contexts which could be defined and used more generically (such as the box interface or a global player interface for example).

Author

Yann Renard (INRIA/IRISA)

Date

2006-07-07

See also

OpenViBE::Kernel::IBoxAlgorithm

OpenViBE::Kernel::IPlayerContext

Member Function Documentation

virtual const OpenViBE::Kernel::IBox* getStaticBoxContext ( void  )

pure virtual

Gets the static context of the box corresponding to the algorithm.

Returns

A pointer on the corresponding context

The returned context can be used by the algorithm to access the box' prototype.

Warning

The algorithm should not use this reference after it has finished its work, it could be deprecated.

See also

OpenViBE::Kernel::IBoxAlgorithmContext::getDynamicBoxContext

virtual OpenViBE::Kernel::IBoxIO* getDynamicBoxContext ( void  )

pure virtual

Gets the dynamic context of the box corresponding to the algorithm.

Returns

A pointer on the corresponding context

The returned context can be used by the algorithm to access the box' inputs, outputs and settings.

Warning

The algorithm should not use this reference after it has finished its work, it could be deprecated.

See also

OpenViBE::Kernel::IBoxAlgorithmContext::getStaticBoxContext

virtual OpenViBE::Kernel::IPlayerContext* getPlayerContext ( void  )

pure virtual

Gets the player context.

Returns

A pointer on the player context

The returned context can be used by the algorithm to access the player functionnalities.

Warning

The algorithm should not use this reference after it has finished its work, it could be deprecated.

virtual OpenViBE::boolean markAlgorithmAsReadyToProcess ( void  )

pure virtual

Marks the algorithm as 'ready to process' so its process function is called by the kernel.

Returns

true in case of success.

false when an error occurs.

This function should be called by the algorithm itself after receiving a message so the kernel knows it is ready to process some data... As soon as the kernel knows the algorithm is ready, the process function is called so the algorithm does its work and produces its outputs.