Public Member Functions | List of all members
IAlgorithmContext Class Referenceabstract
Kernel components » Algorithms management | Kernel components | Extension mechanism

Exectution context for algorithm objects. More...

Inheritance diagram for IAlgorithmContext:
IKernelObject IObject

Public Member Functions

virtual OpenViBE::Kernel::IConfigurationManager & getConfigurationManager (void) const =0
 Gets a reference on the current configuration manager. More...
 
virtual OpenViBE::Kernel::IAlgorithmManager & getAlgorithmManager (void) const =0
 Gets a reference on the current algorithm manager. More...
 
virtual OpenViBE::Kernel::ILogManager & getLogManager (void) const =0
 Gets a reference on the current log manager. More...
 
virtual OpenViBE::Kernel::IErrorManager & getErrorManager (void) const =0
 Gets a reference on the current error manager. More...
 
virtual OpenViBE::Kernel::ITypeManager & getTypeManager (void) const =0
 Gets a reference on the current type manager. More...
 
Input parameters
virtual OpenViBE::CIdentifier getNextInputParameterIdentifier (const OpenViBE::CIdentifier &rPreviousInputParameterIdentifier) const =0
 Gets next input parameter identifier given the previous input parameter. More...
 
virtual OpenViBE::Kernel::IParameter * getInputParameter (const OpenViBE::CIdentifier &rInputParameterIdentifier)=0
 Gets the parameter details of a specific input parameter. More...
 
Output parameters
virtual OpenViBE::CIdentifier getNextOutputParameterIdentifier (const OpenViBE::CIdentifier &rPreviousOutputParameterIdentifier) const =0
 Gets next output parameter identifier given the previous output parameter. More...
 
virtual OpenViBE::Kernel::IParameter * getOutputParameter (const OpenViBE::CIdentifier &rOutputParameterIdentifier)=0
 Gets the parameter details of a specific output parameter. More...
 
Trigger management
virtual OpenViBE::boolean isInputTriggerActive (const OpenViBE::CIdentifier &rInputTriggerIdentifier) const =0
 Tests whether an input trigger is activated or not. More...
 
virtual OpenViBE::boolean activateOutputTrigger (const OpenViBE::CIdentifier &rOutputTriggerIdentifier, const OpenViBE::boolean bTriggerState)=0
 Activates an output trigger before calling the processing function. More...
 
- Public Member Functions inherited from IObject
virtual OpenViBE::CIdentifier getClassIdentifier (void) const =0
 Returns the final class identifier of the concrete class. More...
 
virtual OpenViBE::boolean isDerivedFromClass (const OpenViBE::CIdentifier &rClassIdentifier) const
 Checks if this object is compatible with a class identifier. More...
 
virtual OpenViBE::boolean acceptVisitor (OpenViBE::IObjectVisitor &rObjectVisitor)
 Requests this object to accept a visitor. More...
 

Detailed Description

Exectution context for algorithm objects.

Author
Yann Renard (INRIA/IRISA)
Date
2007-11-06
See also
OpenViBE::Plugins::IAlgorithm

Member Function Documentation

virtual OpenViBE::Kernel::IConfigurationManager& getConfigurationManager ( void  ) 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.
virtual OpenViBE::Kernel::IAlgorithmManager& getAlgorithmManager ( void  ) 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.
virtual OpenViBE::Kernel::ILogManager& getLogManager ( void  ) 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.
virtual OpenViBE::Kernel::IErrorManager& getErrorManager ( void  ) 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.
virtual OpenViBE::Kernel::ITypeManager& getTypeManager ( void  ) const
pure virtual

Gets a reference on the current type manager.

Returns
a reference on the current type manager
virtual OpenViBE::CIdentifier getNextInputParameterIdentifier ( const OpenViBE::CIdentifier &  rPreviousInputParameterIdentifier) const
pure virtual

Gets next input parameter identifier given the previous input parameter.

Parameters
rPreviousInputParameterIdentifier[in] : the previous input parameter
Returns
the next input parameter identifier if existing.
OV_UndefinedIdentifier if the previous was the last input parameter identifier.
Note
Passing OV_UndefinedIdentifier as rPreviousInputParameterIdentifier will cause this function to return the firs input parameter identifier.
virtual OpenViBE::Kernel::IParameter* getInputParameter ( const OpenViBE::CIdentifier &  rInputParameterIdentifier)
pure virtual

Gets the parameter details of a specific input parameter.

Parameters
rInputParameterIdentifier[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.
virtual OpenViBE::CIdentifier getNextOutputParameterIdentifier ( const OpenViBE::CIdentifier &  rPreviousOutputParameterIdentifier) const
pure virtual

Gets next output parameter identifier given the previous output parameter.

Parameters
rPreviousOutputParameterIdentifier[in] : the previous output parameter
Returns
the next output parameter identifier if existing.
OV_UndefinedIdentifier if the previous was the last output parameter identifier.
Note
Passing OV_UndefinedIdentifier as rPreviousOutputParameterIdentifier will cause this function to return the firs output parameter identifier.
virtual OpenViBE::Kernel::IParameter* getOutputParameter ( const OpenViBE::CIdentifier &  rOutputParameterIdentifier)
pure virtual

Gets the parameter details of a specific output parameter.

Parameters
rOutputParameterIdentifier[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.
virtual OpenViBE::boolean isInputTriggerActive ( const OpenViBE::CIdentifier &  rInputTriggerIdentifier) const
pure virtual

Tests whether an input trigger is activated or not.

Parameters
rInputTriggerIdentifier[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.
virtual OpenViBE::boolean activateOutputTrigger ( const OpenViBE::CIdentifier &  rOutputTriggerIdentifier,
const OpenViBE::boolean  bTriggerState 
)
pure virtual

Activates an output trigger before calling the processing function.

Parameters
rOutputTriggerIdentifier[in] : the identifier of the output to activate
bTriggerState[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.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by  doxygen 1.7.4