IComment Class Reference

A comment class for scenariosThis interface can be used in order to fully describe an OpenViBE comment in order to help the understanding of a given scenario. More...

Inheritance diagram for IComment:

List of all members.

Public Member Functions
Comment naming and identification
virtual OpenViBE::CIdentifier	getIdentifier (void) const =0
	Gets the identifier of this comment.
virtual OpenViBE::CString	getText (void) const =0
	Gets the display name of this comment.
virtual OpenViBE::boolean	setIdentifier (const OpenViBE::CIdentifier &rIdentifier)=0
	Changes the identifier of this comment.
virtual OpenViBE::boolean	setText (const OpenViBE::CString &sText)=0
	Changes the text of this comment.
Initialisation from prototypes etc...
virtual OpenViBE::boolean	initializeFromExistingComment (const OpenViBE::Kernel::IComment &rExisitingComment)=0
	Initializes the comment from an already existing comment.

---

Detailed Description

A comment class for scenarios

This interface can be used in order to fully describe an OpenViBE comment in order to help the understanding of a given scenario.

Author:

Yann Renard INRIA

Date:

2010-04-27

---

Member Function Documentation

virtual OpenViBE::CIdentifier getIdentifier

(

void

)

const [pure virtual]

Gets the identifier of this comment.

Returns:

The identifier of this OpenViBE comment.

virtual OpenViBE::CString getText

(

void

)

const [pure virtual]

Gets the display name of this comment.

Returns:

The name of this OpenViBE comment.

virtual OpenViBE::boolean setIdentifier

(

const OpenViBE::CIdentifier &

rIdentifier

)

[pure virtual]

Changes the identifier of this comment.

Parameters:

rIdentifier

[in] : The new identifier this comment should take.

Returns:

true in case of success.

false in case of error.

virtual OpenViBE::boolean setText

(

const OpenViBE::CString &

sText

)

[pure virtual]

Changes the text of this comment.

Parameters:

sText

[in] : The text this comment should contain

Returns:

true in case of success.

false in case of error.

virtual OpenViBE::boolean initializeFromExistingComment

(

const OpenViBE::Kernel::IComment &

rExisitingComment

)

[pure virtual]

Initializes the comment from an already existing comment.

Parameters:

rExisitingComment

[in] : The existing box.

Returns:

true in case of success.

false in case of error.

Resets the comment and initializes its text/attributes according to the existing comment.