IAlgorithmProto Class Referenceabstract

Prototype interface for algorithm. More...

Inherits IKernelObject.

Inherited by CDummyAlgoProto, and TKernelObject< OpenViBE::Kernel::IAlgorithmProto >.

Public Member Functions

virtual OpenViBE::boolean addInputParameter (const OpenViBE::CIdentifier &rInputParameterIdentifier, const OpenViBE::CString &sInputName, const OpenViBE::Kernel::EParameterType eParameterType, const OpenViBE::CIdentifier &rSubTypeIdentifier=OV_UndefinedIdentifier)=0
 Adds an input parameter. More...
 
virtual OpenViBE::boolean addOutputParameter (const OpenViBE::CIdentifier &rOutputParameterIdentifier, const OpenViBE::CString &sOutputName, const OpenViBE::Kernel::EParameterType eParameterType, const OpenViBE::CIdentifier &rSubTypeIdentifier=OV_UndefinedIdentifier)=0
 Adds an output parameter. More...
 
virtual OpenViBE::boolean addInputTrigger (const OpenViBE::CIdentifier &rInputTriggerIdentifier, const OpenViBE::CString &rInputTriggerName)=0
 Adds an input trigger. More...
 
virtual OpenViBE::boolean addOutputTrigger (const OpenViBE::CIdentifier &rOutputTriggerIdentifier, const OpenViBE::CString &rOutputTriggerName)=0
 Adds an output trigger. More...
 

Detailed Description

Prototype interface for algorithm.

Author
Yann Renard (INRIA/IRISA)
Date
2007-11-21
See Also
OpenViBE::Plugins::IAlgorithm
OpenViBE::Plugins::IAlgorithmDesc

Member Function Documentation

virtual OpenViBE::boolean addInputParameter ( const OpenViBE::CIdentifier rInputParameterIdentifier,
const OpenViBE::CString sInputName,
const OpenViBE::Kernel::EParameterType  eParameterType,
const OpenViBE::CIdentifier rSubTypeIdentifier = OV_UndefinedIdentifier 
)
pure virtual

Adds an input parameter.

Parameters
rInputParameterIdentifier[in] : the identifier for this parameter
sInputName[in] : the name for this parameter
eParameterType[in] : the type for this parameter
rSubTypeIdentifier[in] : the optional sub type of this parameter (e.g. for enumerations)
Returns
true in case of success.
false in case of error.
See Also
IParameter
virtual OpenViBE::boolean addOutputParameter ( const OpenViBE::CIdentifier rOutputParameterIdentifier,
const OpenViBE::CString sOutputName,
const OpenViBE::Kernel::EParameterType  eParameterType,
const OpenViBE::CIdentifier rSubTypeIdentifier = OV_UndefinedIdentifier 
)
pure virtual

Adds an output parameter.

Parameters
rOutputParameterIdentifier[in] : the identifier for this parameter
sOutputName[in] : the name for this parameter
eParameterType[in] : the type for this parameter
rSubTypeIdentifier[in] : the optional sub type of this parameter (e.g. for enumerations)
Returns
true in case of success.
false in case of error.
See Also
IParameter
virtual OpenViBE::boolean addInputTrigger ( const OpenViBE::CIdentifier rInputTriggerIdentifier,
const OpenViBE::CString rInputTriggerName 
)
pure virtual

Adds an input trigger.

Parameters
rInputTriggerIdentifier[in] : the identifier for this trigger
rInputTriggerName[in] : the name for this trigger
Returns
true in case of success.
false in case of error.
virtual OpenViBE::boolean addOutputTrigger ( const OpenViBE::CIdentifier rOutputTriggerIdentifier,
const OpenViBE::CString rOutputTriggerName 
)
pure virtual

Adds an output trigger.

Parameters
rOutputTriggerIdentifier[in] : the identifier for this trigger
rOutputTriggerName[in] : the name for this trigger
Returns
true in case of success.
false in case of error.