IStimulationSet Class Reference

Basic OpenViBE stimulation set interface. More...

Inheritance diagram for IStimulationSet:

List of all members.

Public Member Functions
virtual void	clear (void)=0
	Clears this stimulation set removing every existing stimulation.
virtual const OpenViBE::uint64	getStimulationCount (void) const =0
	Gets the number of stimulations contained in this stimulation set.
virtual const OpenViBE::uint64	getStimulationIdentifier (const OpenViBE::uint64 ui64StimulationIndex) const =0
	Gets the identifier of a specific stimulation in this stimulation set.
virtual const OpenViBE::uint64	getStimulationDate (const OpenViBE::uint64 ui64StimulationIndex) const =0
	Gets the date of a specific stimulation in this stimulation set.
virtual const OpenViBE::uint64	getStimulationDuration (const OpenViBE::uint64 ui64StimulationIndex) const =0
	Gets the duration of a specific stimulation in this stimulation set.
virtual OpenViBE::boolean	setStimulationCount (const OpenViBE::uint64 ui64StimulationCount)=0
	Changes the stimulation count in this stimulation set.
virtual OpenViBE::boolean	setStimulationIdentifier (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationIdentifier)=0
	Changes the identifier of a specific stimulation in this stimulation set.
virtual OpenViBE::boolean	setStimulationDate (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationDate)=0
	Changes the date of a specific stimulation in this stimulation set.
virtual OpenViBE::boolean	setStimulationDuration (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationDuration)=0
	Changes the duration of a specific stimulation in this stimulation set.
virtual OpenViBE::uint64	appendStimulation (const OpenViBE::uint64 ui64StimulationIdentifier, const OpenViBE::uint64 ui64StimulationDate, const OpenViBE::uint64 ui64StimulationDuration)=0
	Appends a stimulation to this stimulation set.
virtual OpenViBE::uint64	insertStimulation (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationIdentifier, const OpenViBE::uint64 ui64StimulationDate, const OpenViBE::uint64 ui64StimulationDuration)=0
	Inserts a stimulation to this stimulation set.
virtual OpenViBE::boolean	removeStimulation (const OpenViBE::uint64 ui64StimulationIndex)=0
	Removes a stimulation from this stimulation set.

---

Detailed Description

Basic OpenViBE stimulation set interface.

Author:

Yann Renard (INRIA/IRISA)

Date:

2007-11-21 This interface offers functionalities to handle a collection of OpenViBE stimulations. This collection basicaly consists in a list of stimulation information. Each stimulation has three information : an identifier, a date and a duration.

OpenViBE provides an standalone implementation of this interface in OpenViBE::CStimulationSet

---

Member Function Documentation

virtual const OpenViBE::uint64 getStimulationCount

(

void

)

const [pure virtual]

Gets the number of stimulations contained in this stimulation set.

Returns:

the number of stimulations contained in this stimulation set.

Implemented in CStimulationSet.

virtual const OpenViBE::uint64 getStimulationIdentifier

(

const OpenViBE::uint64

ui64StimulationIndex

)

const [pure virtual]

Gets the identifier of a specific stimulation in this stimulation set.

Parameters:

ui64StimulationIndex

[in] : the index of the stimulation which identifier has to be returned

Returns:

the identifier for the specified stimulation.

Implemented in CStimulationSet.

virtual const OpenViBE::uint64 getStimulationDate

(

const OpenViBE::uint64

ui64StimulationIndex

)

const [pure virtual]

Gets the date of a specific stimulation in this stimulation set.

Parameters:

ui64StimulationIndex

[in] : the index of the stimulation which date has to be returned

Returns:

the date for the specified stimulation.

Note:

the returned date is relative to the beginning of this stimulation set

dates and durations are returned in seconds fixed point 32:32. Refer to for more details

Implemented in CStimulationSet.

virtual const OpenViBE::uint64 getStimulationDuration

(

const OpenViBE::uint64

ui64StimulationIndex

)

const [pure virtual]

Gets the duration of a specific stimulation in this stimulation set.

Parameters:

ui64StimulationIndex

[in] : the index of the stimulation which duration has to be returned

Returns:

the duration for the specified stimulation.

Note:

dates and durations are returned in seconds fixed point 32:32. Refer to for more details

Implemented in CStimulationSet.

virtual OpenViBE::boolean setStimulationCount

(

const OpenViBE::uint64

ui64StimulationCount

)

[pure virtual]

Changes the stimulation count in this stimulation set.

Parameters:

ui64StimulationCount

[in] : the new number of stimulations

Returns:

true in case of success.

false in case of error.

Implemented in CStimulationSet.

virtual OpenViBE::boolean setStimulationIdentifier	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationIdentifier
	)		[pure virtual]

Changes the identifier of a specific stimulation in this stimulation set.

Parameters:

ui64StimulationIndex	[in] : the index of the stimulation which identifier should be changed
ui64StimulationIdentifier	[in] : the new identifier for the specified stimulation

Returns:

true in case of success.

false in case of error.

Implemented in CStimulationSet.

virtual OpenViBE::boolean setStimulationDate	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationDate
	)		[pure virtual]

Changes the date of a specific stimulation in this stimulation set.

Parameters:

ui64StimulationIndex	[in] : the index of the stimulation which date should be changed
ui64StimulationDate	[in] : the new date for the specified stimulation

Returns:

true in case of success.

false in case of error.

Note:

dates and durations are returned in seconds fixed point 32:32. Refer to for more details

Implemented in CStimulationSet.

virtual OpenViBE::boolean setStimulationDuration	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationDuration
	)		[pure virtual]

Changes the duration of a specific stimulation in this stimulation set.

Parameters:

ui64StimulationIndex	[in] : the index of the stimulation which duration should be changed
ui64StimulationDuration	[in] : the new duration for the specified stimulation

Returns:

true in case of success.

false in case of error.

Note:

the returned date is relative to the beginning of this stimulation set

dates and durations are returned in seconds fixed point 32:32. Refer to for more details

Implemented in CStimulationSet.

virtual OpenViBE::uint64 appendStimulation	(	const OpenViBE::uint64	ui64StimulationIdentifier,
		const OpenViBE::uint64	ui64StimulationDate,
		const OpenViBE::uint64	ui64StimulationDuration
	)		[pure virtual]

Appends a stimulation to this stimulation set.

Parameters:

ui64StimulationIdentifier	[in] : the identifier of the stimulation to append
ui64StimulationDate	[in] : the date of the stimulation
ui64StimulationDuration	[in] : the duration of the stimulation

Returns:

the index of the appended stimulation in this stimulation set

Implemented in CStimulationSet.

virtual OpenViBE::uint64 insertStimulation	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationIdentifier,
		const OpenViBE::uint64	ui64StimulationDate,
		const OpenViBE::uint64	ui64StimulationDuration
	)		[pure virtual]

Inserts a stimulation to this stimulation set.

Parameters:

ui64StimulationIndex	[in] : the index of the stimulation to insert
ui64StimulationIdentifier	[in] : the identifier of the stimulation
ui64StimulationDate	[in] : the date of the stimulation
ui64StimulationDuration	[in] : the duration of the stimulation

Returns:

true in case of success

false in case of error

Warning:

stimulation indexing change after call to this function : following stimulation(s) get one more indexed.

Implemented in CStimulationSet.

virtual OpenViBE::boolean removeStimulation

(

const OpenViBE::uint64

ui64StimulationIndex

)

[pure virtual]

Removes a stimulation from this stimulation set.

Parameters:

ui64StimulationIndex

[in] : the index of the stimulation to remove

Returns:

true in case of success

false in case of error

Warning:

stimulation indexing change after call to this function : following stimulation(s) get one less indexed.

Implemented in CStimulationSet.