IScenarioManager Class Reference

The scenario managerThis manager is responsible to organize and handle all the scenarios of the kernel. More...

Inheritance diagram for IScenarioManager:

List of all members.

Public Member Functions
virtual OpenViBE::CIdentifier	getNextScenarioIdentifier (const OpenViBE::CIdentifier &rPreviousIdentifier) const =0
	Gets next scenario identifier.
virtual OpenViBE::boolean	createScenario (OpenViBE::CIdentifier &rScenarioIdentifier)=0
	Creates a new scenario.
virtual OpenViBE::boolean	releaseScenario (const OpenViBE::CIdentifier &rScenarioIdentifier)=0
	Releases an existing scenario.
virtual OpenViBE::Kernel::IScenario &	getScenario (const OpenViBE::CIdentifier &rScenarioIdentifier)=0
	Gets details on a specific scenario.

---

Detailed Description

The scenario manager

This manager is responsible to organize and handle all the scenarios of the kernel.

Author:

Yann Renard (IRISA/INRIA)

Date:

2006-10-05

---

Member Function Documentation

virtual OpenViBE::CIdentifier getNextScenarioIdentifier

(

const OpenViBE::CIdentifier &

rPreviousIdentifier

)

const [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 as rPreviousIdentifier will cause this function to return the first scenario identifier.

virtual OpenViBE::boolean createScenario

(

OpenViBE::CIdentifier &

rScenarioIdentifier

)

[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.

virtual OpenViBE::boolean releaseScenario

(

const OpenViBE::CIdentifier &

rScenarioIdentifier

)

[pure virtual]

Releases an existing scenario.

Parameters:

rScenarioIdentifier

[in] : the existing scenario identifier

Returns:

true in case of success.

false in case of error.

virtual OpenViBE::Kernel::IScenario& getScenario

(

const OpenViBE::CIdentifier &

rScenarioIdentifier

)

[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