Basic standalone OpenViBE stimulation set implementationThis class offers a basic standalone impementation of the OpenViBE::IStimulationSet interface. This class can be directly instanciated and used. More...

Inheritance diagram for CStimulationSet:

Public Member Functions
virtual void	clear (void)
	Clears this stimulation set removing every existing stimulation.

virtual const OpenViBE::uint64	getStimulationCount (void) const
	Gets the number of stimulations contained in this stimulation set. More...

virtual const OpenViBE::uint64	getStimulationIdentifier (const OpenViBE::uint64 ui64StimulationIndex) const
	Gets the identifier of a specific stimulation in this stimulation set. More...

virtual const OpenViBE::uint64	getStimulationDate (const OpenViBE::uint64 ui64StimulationIndex) const
	Gets the date of a specific stimulation in this stimulation set. More...

virtual const OpenViBE::uint64	getStimulationDuration (const OpenViBE::uint64 ui64StimulationIndex) const
	Gets the duration of a specific stimulation in this stimulation set. More...

virtual OpenViBE::boolean	setStimulationCount (const OpenViBE::uint64 ui64StimulationCount)
	Changes the stimulation count in this stimulation set. More...

virtual OpenViBE::boolean	setStimulationIdentifier (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationIdentifier)
	Changes the identifier of a specific stimulation in this stimulation set. More...

virtual OpenViBE::boolean	setStimulationDate (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationDate)
	Changes the date of a specific stimulation in this stimulation set. More...

virtual OpenViBE::boolean	setStimulationDuration (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationDuration)
	Changes the duration of a specific stimulation in this stimulation set. More...

virtual OpenViBE::uint64	appendStimulation (const OpenViBE::uint64 ui64StimulationIdentifier, const OpenViBE::uint64 ui64StimulationDate, const OpenViBE::uint64 ui64StimulationDuration)
	Appends a stimulation to this stimulation set. More...

virtual OpenViBE::uint64	insertStimulation (const OpenViBE::uint64 ui64StimulationIndex, const OpenViBE::uint64 ui64StimulationIdentifier, const OpenViBE::uint64 ui64StimulationDate, const OpenViBE::uint64 ui64StimulationDuration)
	Inserts a stimulation to this stimulation set. More...

virtual OpenViBE::boolean	removeStimulation (const OpenViBE::uint64 ui64StimulationIndex)
	Removes a stimulation from this stimulation set. More...

Constructors
	CStimulationSet (void)
	Default constructor. More...

virtual	~CStimulationSet (void)
	Destructor. 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

Basic standalone OpenViBE stimulation set implementation

This class offers a basic standalone impementation of the OpenViBE::IStimulationSet interface. This class can be directly instanciated and used.

Author: Yann Renard (INRIA/IRISA)

Date: 2007-11-21 Instances of this class use an internal implementation of the OpenViBE::IStimulationSet interface and redirect their calls to this implementation.

Constructor & Destructor Documentation

CStimulationSet ( void )

Default constructor.

This constructor builds the internal implementation of this stimulation set.

~CStimulationSet ( void )

virtual

Destructor.

The internal implementation is released.

Member Function Documentation

const uint64 getStimulationCount ( void ) const

virtual

Gets the number of stimulations contained in this stimulation set.

Returns: the number of stimulations contained in this stimulation set.

Implements IStimulationSet.

References IStimulationSet::getStimulationCount().

const uint64 getStimulationIdentifier ( const OpenViBE::uint64 ui64StimulationIndex ) const

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.

Implements IStimulationSet.

References IStimulationSet::getStimulationIdentifier().

const uint64 getStimulationDate ( const OpenViBE::uint64 ui64StimulationIndex ) const

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

Implements IStimulationSet.

References IStimulationSet::getStimulationDate().

const uint64 getStimulationDuration ( const OpenViBE::uint64 ui64StimulationIndex ) const

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

Implements IStimulationSet.

References IStimulationSet::getStimulationDuration().

boolean setStimulationCount ( const OpenViBE::uint64 ui64StimulationCount )

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.

Implements IStimulationSet.

References IStimulationSet::setStimulationCount().

boolean setStimulationIdentifier	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationIdentifier
	)

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.

Implements IStimulationSet.

References IStimulationSet::setStimulationIdentifier().

boolean setStimulationDate	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationDate
	)

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

Implements IStimulationSet.

References IStimulationSet::setStimulationDate().

boolean setStimulationDuration	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationDuration
	)

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

Implements IStimulationSet.

References IStimulationSet::setStimulationDuration().

uint64 appendStimulation	(	const OpenViBE::uint64	ui64StimulationIdentifier,
		const OpenViBE::uint64	ui64StimulationDate,
		const OpenViBE::uint64	ui64StimulationDuration
	)

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

Implements IStimulationSet.

References IStimulationSet::appendStimulation().

uint64 insertStimulation	(	const OpenViBE::uint64	ui64StimulationIndex,
		const OpenViBE::uint64	ui64StimulationIdentifier,
		const OpenViBE::uint64	ui64StimulationDate,
		const OpenViBE::uint64	ui64StimulationDuration
	)

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