Exectution context for algorithm objects. More...

#include <ovIAlgorithmContext.h>

Inheritance diagram for OpenViBE::Kernel::IAlgorithmContext:

Public Member Functions
virtual IConfigurationManager &	getConfigurationManager () const =0
	Gets a reference on the current configuration manager. More...

virtual IAlgorithmManager &	getAlgorithmManager () const =0
	Gets a reference on the current algorithm manager. More...

virtual ILogManager &	getLogManager () const =0
	Gets a reference on the current log manager. More...

virtual CErrorManager &	getErrorManager () const =0
	Gets a reference on the current error manager. More...

virtual ITypeManager &	getTypeManager () const =0
	Gets a reference on the current type manager. More...

Input parameters
virtual CIdentifier	getNextInputParameterIdentifier (const CIdentifier &prevInputParameterID) const =0
	Gets next input parameter identifier given the previous input parameter. More...

virtual IParameter *	getInputParameter (const CIdentifier &id)=0
	Gets the parameter details of a specific input parameter. More...

Output parameters
virtual CIdentifier	getNextOutputParameterIdentifier (const CIdentifier &prevOutputParameterID) const =0
	Gets next output parameter identifier given the previous output parameter. More...

virtual IParameter *	getOutputParameter (const CIdentifier &id)=0
	Gets the parameter details of a specific output parameter. More...

Trigger management
virtual bool	isInputTriggerActive (const CIdentifier &id) const =0
	Tests whether an input trigger is activated or not. More...

virtual bool	activateOutputTrigger (const CIdentifier &id, const bool state)=0
	Activates an output trigger before calling the processing function. More...

Public Member Functions inherited from OpenViBE::IObject
virtual CIdentifier	getClassIdentifier () const =0
	Returns the final class identifier of the concrete class. More...

virtual bool	isDerivedFromClass (const CIdentifier &classId) const
	Checks if this object is compatible with a class identifier. More...

virtual bool	acceptVisitor (IObjectVisitor &visitor)
	Requests this object to accept a visitor. More...

Additional Inherited Members
Protected Member Functions inherited from OpenViBE::IObject
virtual	~IObject ()

Detailed Description

Exectution context for algorithm objects.

Author: Yann Renard (INRIA/IRISA)

Date: 2007-11-06

See also: Plugins::IAlgorithm

Member Function Documentation

◆ getConfigurationManager()

virtual IConfigurationManager & OpenViBE::Kernel::IAlgorithmContext::getConfigurationManager ( ) const

pure virtual

Gets a reference on the current configuration manager.

Returns: a reference on the configuration manager

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

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getAlgorithmManager()

virtual IAlgorithmManager & OpenViBE::Kernel::IAlgorithmContext::getAlgorithmManager ( ) const

pure virtual

Gets a reference on the current algorithm manager.

Returns: a reference on the algorithm manager

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

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getLogManager()

virtual ILogManager & OpenViBE::Kernel::IAlgorithmContext::getLogManager ( ) const

pure virtual

Gets a reference on the current log manager.

Returns: a reference on the current log manager

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

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getErrorManager()

virtual CErrorManager & OpenViBE::Kernel::IAlgorithmContext::getErrorManager ( ) const

pure virtual

Gets a reference on the current error manager.

Returns: a reference on the current error manager

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

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getTypeManager()

virtual ITypeManager & OpenViBE::Kernel::IAlgorithmContext::getTypeManager ( ) const

pure virtual

Gets a reference on the current type manager.

Returns: a reference on the current type manager

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getNextInputParameterIdentifier()

virtual CIdentifier OpenViBE::Kernel::IAlgorithmContext::getNextInputParameterIdentifier ( const CIdentifier & prevInputParameterID ) const

pure virtual

Gets next input parameter identifier given the previous input parameter.

Parameters

prevInputParameterID [in] : the previous input parameter

Returns: the next input parameter identifier if existing.; CIdentifier::undefined() if the previous was the last input parameter identifier.

Note: Passing CIdentifier::undefined() as prevInputParameterID will cause this function to return the firs input parameter identifier.

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getInputParameter()

virtual IParameter * OpenViBE::Kernel::IAlgorithmContext::getInputParameter ( const CIdentifier & id )

pure virtual

Gets the parameter details of a specific input parameter.

Parameters

id	[in] : the identifier of the parameter which details should be returned

Returns: the parameter pointer that corresponds to the provided identifier.; NULL in case of error.

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getNextOutputParameterIdentifier()

virtual CIdentifier OpenViBE::Kernel::IAlgorithmContext::getNextOutputParameterIdentifier ( const CIdentifier & prevOutputParameterID ) const

pure virtual

Gets next output parameter identifier given the previous output parameter.

Parameters

prevOutputParameterID [in] : the previous output parameter

Returns: the next output parameter identifier if existing.; CIdentifier::undefined() if the previous was the last output parameter identifier.

Note: Passing CIdentifier::undefined() as prevOutputParameterID will cause this function to return the firs output parameter identifier.

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ getOutputParameter()

virtual IParameter * OpenViBE::Kernel::IAlgorithmContext::getOutputParameter ( const CIdentifier & id )

pure virtual

Gets the parameter details of a specific output parameter.

Parameters

id	[in] : the identifier of the parameter which details should be returned

Returns: the parameter pointer that corresponds to the provided identifier.; NULL in case of error.

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ isInputTriggerActive()

virtual bool OpenViBE::Kernel::IAlgorithmContext::isInputTriggerActive ( const CIdentifier & id ) const

pure virtual

Tests whether an input trigger is activated or not.

Parameters

id	[in] : the identifier of the input trigger which activation status should be returned

Returns: true if the provided trigger is currently active.; false if the provided trigger is not currently active or does not exist.

Implemented in OpenViBE::Kernel::CAlgorithmContext.

◆ activateOutputTrigger()

virtual bool OpenViBE::Kernel::IAlgorithmContext::activateOutputTrigger	(	const CIdentifier &	id,
		const bool	state
	)

pure virtual

Activates an output trigger before calling the processing function.

Parameters

id	[in] : the identifier of the output to activate
state	[in]: the new trigger state this output trigger should take (true for active, false for inactive)

Returns: true in case the state was correctly changed.; false in case the state was not changed or the provided trigger identifier does not exist.

Implemented in OpenViBE::Kernel::CAlgorithmContext.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getConfigurationManager()

◆ getAlgorithmManager()

◆ getLogManager()

◆ getErrorManager()

◆ getTypeManager()

◆ getNextInputParameterIdentifier()

◆ getInputParameter()

◆ getNextOutputParameterIdentifier()

◆ getOutputParameter()

◆ isInputTriggerActive()

◆ activateOutputTrigger()