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...
Public Member Functions | |
| virtual OpenViBE::Kernel::IBox * | getStaticBoxContext (void)=0 |
| Gets the static context of the box corresponding to the algorithm. | |
| virtual OpenViBE::Kernel::IBoxIO * | getDynamicBoxContext (void)=0 |
| Gets the dynamic context of the box corresponding to the algorithm. | |
| virtual OpenViBE::Kernel::IPlayerContext * | getPlayerContext (void)=0 |
| Gets the player context. | |
| virtual OpenViBE::Kernel::IVisualisationContext * | getVisualisationContext (void)=0 |
| Gets the visualisation context. | |
| virtual OpenViBE::boolean | markAlgorithmAsReadyToProcess (void)=0 |
| Marks the algorithm as 'ready to process' so its process function is called by the kernel. | |
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).
- Date:
- 2006-07-07
- See also:
- OpenViBE::Kernel::IBoxAlgorithm
- OpenViBE::Kernel::IPlayerContext
Member Function Documentation
| virtual 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.
| 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.
| 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::Kernel::IVisualisationContext* getVisualisationContext | ( | void | ) | [pure virtual] |
Gets the visualisation context.
- Returns:
- A pointer on the visualisation context
The returned context can be used by the algorithm to access visualisation functionalities.
- 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.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
1.7.4