KernelFacade Class Reference

Wrapper class used to access Kernel featuresThis class is one-to-many interface used as a central point to access a subset of Kernel features. More...

Public Member Functions
PlayerReturnCode	initialize (const InitCommand &command)
	Initialize session parameters. More...
PlayerReturnCode	uninitialize ()
	Reset session parameters.
PlayerReturnCode	loadKernel (const LoadKernelCommand &command)
	Load kernel. More...
PlayerReturnCode	unloadKernel ()
	Unload kernel.
PlayerReturnCode	loadScenario (const LoadScenarioCommand &command)
	Load scenario. More...
PlayerReturnCode	setupScenario (const SetupScenarioCommand &command)
	Configure scenario. More...
PlayerReturnCode	runScenarioList (const RunScenarioCommand &command)
	Run one or multiple scenarios. More...

Detailed Description

Wrapper class used to access Kernel features

This class is one-to-many interface used as a central point to access a subset of Kernel features.

Author

cgarraud (INRIA)

Date

2016-01-26

Member Function Documentation

PlayerReturnCode initialize

(

const InitCommand &

command

)

Initialize session parameters.

Parameters

[in]

command

command containing all mandatory properties

References OpenViBE::Success.

Referenced by InitCommand::execute().

PlayerReturnCode loadKernel

(

const LoadKernelCommand &

command

)

Load kernel.

Parameters

[in]

command

command containing all mandatory properties

References IMetaboxManager::addMetaboxesFromFiles(), IPluginManager::addPluginsFromFiles(), IKernelDesc::createKernel(), IConfigurationManager::expand(), IKernelContext::getConfigurationManager(), IKernelContext::getMetaboxManager(), IKernelContext::getPluginManager(), IKernelContext::initialize(), OpenViBE::KernelInvalidDesc, OpenViBE::KernelLoadingFailure, and OpenViBE::Success.

Referenced by LoadKernelCommand::execute().

PlayerReturnCode loadScenario

(

const LoadScenarioCommand &

command

)

Load scenario.

Parameters

[in]

command

command containing all mandatory properties

References OpenViBE::KernelInternalFailure, and OpenViBE::Success.

Referenced by LoadScenarioCommand::execute().

PlayerReturnCode setupScenario

(

const SetupScenarioCommand &

command

)

Configure scenario.

Parameters

[in]

command

command containing all mandatory properties

References OpenViBE::KernelInternalFailure, OpenViBE::ScenarioNotLoaded, and OpenViBE::Success.

Referenced by SetupScenarioCommand::execute().

PlayerReturnCode runScenarioList

(

const RunScenarioCommand &

command

)

Run one or multiple scenarios.

Parameters

[in]

command

command containing all mandatory properties

References IPlayer::forward(), IPlayer::initialize(), OpenViBE::KernelInternalFailure, IPlayer::play(), IPlayer::setScenario(), CNameValuePairList::setValue(), OpenViBE::Success, and Time::zgetTime().

Referenced by RunScenarioCommand::execute().