IScenarioManager Class Referenceabstract
The scenario managerThis manager is responsible to organize and handle all the scenarios of the kernel. More...
Inherits IKernelObject.
Inherited by TKernelObject< OpenViBE::Kernel::IScenarioManager >.
Public Member Functions | |
virtual OpenViBE::CIdentifier | getNextScenarioIdentifier (const OpenViBE::CIdentifier &rPreviousIdentifier) const =0 |
Gets next scenario identifier. More... | |
virtual OpenViBE::boolean | createScenario (OpenViBE::CIdentifier &rScenarioIdentifier)=0 |
Creates a new scenario. More... | |
virtual OpenViBE::boolean | releaseScenario (const OpenViBE::CIdentifier &rScenarioIdentifier)=0 |
Releases an existing scenario. More... | |
virtual OpenViBE::Kernel::IScenario & | getScenario (const OpenViBE::CIdentifier &rScenarioIdentifier)=0 |
Gets details on a specific scenario. More... | |
Detailed Description
The scenario manager
This manager is responsible to organize and handle all the scenarios of the kernel.
- Date
- 2006-10-05
Member Function Documentation
|
pure virtual |
Gets next scenario identifier.
- Parameters
-
rPreviousIdentifier [in] : The identifier for the preceeding scenario
- Returns
- The identifier of the next scenario in case of success.
-
OV_UndefinedIdentifier
on error.
- Note
- Giving
OV_UndefinedIdentifier
asrPreviousIdentifier
will cause this function to return the first scenario identifier.
|
pure virtual |
Creates a new scenario.
- Parameters
-
rScenarioIdentifier [out] : the identifier of the newly created scenario
- Returns
- true in case of success.
- false in case of error.
|
pure virtual |
Releases an existing scenario.
- Parameters
-
rScenarioIdentifier [in] : the existing scenario identifier
- Returns
- true in case of success.
- false in case of error.
|
pure virtual |
Gets details on a specific scenario.
- Parameters
-
rScenarioIdentifier [in] : the scenario identifier which details should be returned
- Returns
- the corresponding scenario reference.
- Warning
- Calling this function with a bad identifier causes a crash
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
