IBoxProto Class Reference
[Scenario management, Kernel components, Extension mechanism]

OpenViBE box prototype

This class is used by a plugin algorithm descriptor to let the OpenViBE platform know what an algorithm box looks like. It declares several things, like it input types, output types and settings. More...

Inheritance diagram for IBoxProto:

List of all members.

Public Member Functions
virtual OpenViBE::uint32	addInput (const OpenViBE::CString &sName, const OpenViBE::CIdentifier &rTypeIdentifier)=0
	Adds an input to the box.
virtual OpenViBE::uint32	addOutput (const OpenViBE::CString &sName, const OpenViBE::CIdentifier &rTypeIdentifier)=0
	Adds an output to the box.
virtual OpenViBE::uint32	addSetting (const OpenViBE::CString &sName, const OpenViBE::CIdentifier &rTypeIdentifier, const OpenViBE::CString &sDefaultValue)=0
	Adds an setting to the box.
virtual OpenViBE::boolean	addFlag (const OpenViBE::Kernel::EBoxFlag eBoxFlag)=0
	Adds a flag to the box.

---

Detailed Description

OpenViBE box prototype

This class is used by a plugin algorithm descriptor to let the OpenViBE platform know what an algorithm box looks like. It declares several things, like it input types, output types and settings.

Author:

Yann Renard (INRIA/IRISA)

Date:

2006-07-05

See also:

OpenViBE::Kernel::IBoxAlgorithmDesc

---

Member Function Documentation

virtual OpenViBE::uint32 addInput	(	const OpenViBE::CString &	sName,
		const OpenViBE::CIdentifier &	rTypeIdentifier
	)			[pure virtual]

Adds an input to the box.

Parameters:

	sName	[in] : the name of the input to add
	rTypeIdentifier	[in] : the type of the input

Returns:

The created input index.

virtual OpenViBE::uint32 addOutput	(	const OpenViBE::CString &	sName,
		const OpenViBE::CIdentifier &	rTypeIdentifier
	)			[pure virtual]

Adds an output to the box.

Parameters:

	sName	[in] : the name of the output to add
	rTypeIdentifier	[in] : the type of the output

Returns:

The created output index.

virtual OpenViBE::uint32 addSetting	(	const OpenViBE::CString &	sName,
		const OpenViBE::CIdentifier &	rTypeIdentifier,
		const OpenViBE::CString &	sDefaultValue
	)			[pure virtual]

Adds an setting to the box.

Parameters:

	sName	[in] : the name of the setting to add
	rTypeIdentifier	[in] : the type of the setting
	sDefaultValue	[in] : the default value of this setting (used to initialize the box itself)

Returns:

The created setting index.

virtual OpenViBE::boolean addFlag

(

const OpenViBE::Kernel::EBoxFlag

eBoxFlag

)

[pure virtual]

Adds a flag to the box.

Parameters:

eBoxFlag

[in] : the flag to add to the box

Returns:

true in case of success.

false in case of error.