Class storing the managed data sets in an array. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvMemoryChartData:

Public Member Functions
	IlvMemoryChartData ()
	Initializes a new `IlvMemoryChartData` object. More...

virtual	~IlvMemoryChartData ()
	Destructor. More...

virtual IlBoolean	addDataSet (IlvChartDataSet *, IlBoolean=IlFalse)
	Adds a managed data set. More...

virtual IlvChartDataSet *	getDataSet (IlUInt) const
	Gets a managed data set by its index. More...

virtual IlUInt	getDataSetsCount () const
	Returns the number of managed data sets. More...

IlUInt	getMaxDataSetsCount () const
	Returns the maximum number of data sets that can be managed. More...

virtual IlBoolean	insertDataSet (IlvChartDataSet *, IlUInt=IlvLastPositionIndex, IlBoolean=IlFalse)
	Inserts a managed data set. More...

virtual IlBoolean	isLimited () const
	Indicates whether the number of managed data sets is limited. More...

virtual IlBoolean	removeDataSet (IlUInt)
	Removes a managed data set. More...

virtual void	removeDataSets ()
	Removes all the managed data sets. More...

virtual IlBoolean	setDataSet (IlUInt, IlvChartDataSet *, IlBoolean=IlFalse)
	Sets a managed data set. More...

virtual IlBoolean	setDataSets (IlUInt &, IlvChartDataSet const , IlBoolean=IlFalse)
	Sets the managed data sets. More...

void	setMaxDataSetsCount (IlUInt maxCount)
	Sets the maximum number of data sets that can be managed. More...

Public Member Functions inherited from IlvAbstractChartData
virtual	~IlvAbstractChartData ()
	Destructor. More...

void	addListener (IlvChartDataListener *lst)
	Adds a listener. More...

virtual IlvAbstractChartData *	copy () const =0
	Creates and returns a copy of the current object. More...

virtual void	dataAllPointsRemoved (const IlvChartDataSet *ds) const
	Performs the updates needed when a data point is removed. More...

virtual void	dataPointAdded (const IlvChartDataSet *dataSet, IlUInt position) const
	Performs the updates needed when a data point is added. More...

virtual void	dataPointChanged (const IlvChartDataSet *dataSet, IlUInt ptidx, IlBoolean beforeChange) const
	Performs the updates needed when a data point is changed. More...

virtual void	dataPointRemoved (const IlvChartDataSet *dataSet, IlUInt ptidx) const
	Performs the updates needed when a data point is removed. More...

virtual void	dataSetAdded (IlvChartDataSet *dataSet, IlUInt position)
	Performs the updates needed when a data set is added. More...

virtual void	dataSetChanged (IlvChartDataSet oldSet, IlvChartDataSet newSet)
	Performs the updates needed when a data set is changed. More...

virtual void	dataSetRemoved (IlvChartDataSet *dataSet)
	Performs the necessary updates when a data set is removed. More...

virtual void	endBatch (const IlvChartDataSet *dataSet) const
	Specifies the end of a set of modifications on a data set. More...

IlvChartDataSet *	getDataSetByName (const char *name) const
	Gets a managed data set by its name. More...

IlUInt	getDataSetIndex (const IlvChartDataSet *dataSet) const
	Returns the index of a managed data set. More...

virtual IlvChartDataSet const	getDataSets (IlUInt &nbDataSets) const
	Returns all the managed data sets. More...

IlvChartDataListener const	getListeners (IlUInt &count) const
	Returns all the listeners. More...

virtual IlBoolean	isRemovalAllowed () const
	Indicates whether the managed data sets can be removed. More...

virtual IlBoolean	isWritable () const
	Indicates whether the managed data sets can be modified. More...

void	lock ()
	Locks the current `IlvAbstractChartData` object. More...

IlvChartDataSet *	operator[] (IlUInt index)
	Gets a managed data set by its index. More...

const IlvChartDataSet *	operator[] (IlUInt index) const
	Gets a managed data set by its index. More...

IlvChartDataListener *	removeListener (IlvChartDataListener *lst)
	Removes a listener. More...

void	removeListeners ()
	Removes all the listeners.

IlBoolean	replaceDataSet (IlvChartDataSet oldDataSet, IlvChartDataSet newDataSet)
	Replaces a managed data set by another one. More...

IlvOutputFile &	save (IlvOutputFile &file) const
	Writes a complete description of the current object in a file. More...

virtual void	startBatch (const IlvChartDataSet *dataSet) const
	Specifies the beginning of a set of modifications on a data set. More...

void	unLock ()
	Unlocks the current `IlvAbstractChartData` object. More...

virtual void	write (IlvOutputFile &file) const =0
	Writes the attributes of the current object in a file. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvAbstractChartData
static IlvAbstractChartData *	Load (IlvInputFile &file)
	Reads a chart data object from a file. More...

Protected Member Functions inherited from IlvAbstractChartData
	IlvAbstractChartData ()
	Initializes a new `IlvAbstractChartData` object.

	IlvAbstractChartData (const IlvAbstractChartData &cData)
	Initializes a new `IlvAbstractChartData` object as a copy of another `IlvAbstractChartData`. More...

	IlvAbstractChartData (IlvInputFile &file)
	Initializes a new `IlvAbstractChartData` object from an input file. More...

Detailed Description

Class storing the managed data sets in an array.

Library: ilvcharts
This class is a subclass of IlvAbstractChartData that stores the managed data sets in memory.

See also: IlvAbstractChartData, IlvChartDataSet.

Constructor & Destructor Documentation

§ IlvMemoryChartData()

IlvMemoryChartData::IlvMemoryChartData ( )

Initializes a new IlvMemoryChartData object.

By default, the maximum data set count is set to IlvNoCountLimit, which means that the number of data sets that can be managed by this object is not limited.

§ ~IlvMemoryChartData()

virtual IlvMemoryChartData::~IlvMemoryChartData ( )

virtual

Destructor.

The destructor removes from the current object all the data sets managed by this object.

Note: The data sets are not deleted but unlocked (that is, the IlvChartDataSet::unLock() method is called). They will be deleted only when no objects reference them.

Member Function Documentation

§ addDataSet()

virtual IlBoolean IlvMemoryChartData::addDataSet	(	IlvChartDataSet *	dataSet,
		IlBoolean	copy = `IlFalse`
	)

virtual

Adds a managed data set.

Parameters

dataSet	The data set to add to the current object.
copy	Indicates whether the data set passed as a parameter must be copied. If copy is `IlTrue`, the data set is copied. Otherwise, a pointer to the data set stored in dataSet is kept. Therefore, its contents should not be deleted.

Returns: IlTrue if the data set has been successfully added or IlFalse otherwise.

Note: When you add a data set, the new data set is locked.

Implements IlvAbstractChartData.

§ getDataSet()

virtual IlvChartDataSet* IlvMemoryChartData::getDataSet ( IlUInt index ) const

virtual

Gets a managed data set by its index.

Parameters

index The index of the returned data set in the current object.

Returns: A pointer to the data set at the index index if it exists and 0 otherwise.

Note: The data set object must not be deleted by the user since it is maintained internally.

Implements IlvAbstractChartData.

§ getDataSetsCount()

virtual IlUInt IlvMemoryChartData::getDataSetsCount ( ) const

virtual

Returns the number of managed data sets.

Returns: The number of data sets managed by this object.

Implements IlvAbstractChartData.

§ getMaxDataSetsCount()

IlUInt IlvMemoryChartData::getMaxDataSetsCount ( ) const

Returns the maximum number of data sets that can be managed.

Returns: IlvNoCountLimit if the number of data sets that can be managed by the current object is not limited. Otherwise, it returns the maximum number of data sets that can be managed by the current object.

§ insertDataSet()

virtual IlBoolean IlvMemoryChartData::insertDataSet	(	IlvChartDataSet *	dataSet,
		IlUInt	index = `IlvLastPositionIndex`,
		IlBoolean	copy = `IlFalse`
	)

virtual

Inserts a managed data set.

Parameters

dataSet	The data set to insert in the current object.
index	The index at which the data set dataSet must be inserted in the current object.
copy	Indicates whether the data set passed as a parameter must be copied. If copy is `IlTrue`, the data set is copied. Otherwise, a pointer to the data set stored in dataSet is kept. Therefore, its contents should not be deleted.

Returns: IlTrue if the data set has been successfully inserted or IlFalse otherwise.

Note: When you insert a data set, the new data set is locked.

Implements IlvAbstractChartData.

§ isLimited()

virtual IlBoolean IlvMemoryChartData::isLimited ( ) const

virtual

Indicates whether the number of managed data sets is limited.

Returns: IlFalse if the number of managed data sets is not limited (that is, the maximum data sets count is equal to IlvNoCountLimit) and IlTrue otherwise.

Reimplemented from IlvAbstractChartData.

§ removeDataSet()

virtual IlBoolean IlvMemoryChartData::removeDataSet ( IlUInt dataSetIndex )

virtual

Removes a managed data set.

Parameters

dataSetIndex The index at which the data set must be removed from the current object.

Returns: IlTrue if the data set has been removed or IlFalse otherwise.

Note: When you remove a data set, the data set is not deleted but unlocked (that is, the IlvChartDataSet::unLock() method is called). It will be deleted only when no objects reference it.

Implements IlvAbstractChartData.

§ removeDataSets()

virtual void IlvMemoryChartData::removeDataSets ( )

virtual

Removes all the managed data sets.

Note: When you remove a data set, the data set is not deleted but unlocked (that is, the IlvChartDataSet::unLock() method is called). It will be deleted only when no objects reference it.

Implements IlvAbstractChartData.

§ setDataSet()

virtual IlBoolean IlvMemoryChartData::setDataSet	(	IlUInt	dataSetIndex,
		IlvChartDataSet *	dataSet,
		IlBoolean	copy = `IlFalse`
	)

virtual

Sets a managed data set.

If a data set already exists at the index dataSetIndex, the data set is replaced by the new one. Otherwise, the new one is added at the end.

Parameters

dataSetIndex	The index at which the data set dataSet must be set in the current object.
dataSet	The data set to set in the current object.
copy	Indicates whether the data set passed as a parameter must be copied. If copy is `IlTrue`, the data set is copied. Otherwise, a pointer to the data set stored in dataSet is kept. Therefore, its contents should not be deleted.

Returns: IlTrue if the data set has been successfully set or IlFalse otherwise.

Note: When you set a data set, the new data set is locked and the old one, if it exists, is unlocked.

Implements IlvAbstractChartData.

§ setDataSets()

virtual IlBoolean IlvMemoryChartData::setDataSets	(	IlUInt &	count,
		IlvChartDataSet const	dataSets,
		IlBoolean	copy = `IlFalse`
	)

virtual

Sets the managed data sets.

Parameters

count	This parameter first contains the number of data sets in the array dataSets. It is eventually modified to contain the number of data sets that have actually been set, if not all the data sets have been set in the current object.
dataSets	An array of the data sets to set in the current object.
copy	Indicates whether the data sets passed as parameters must be copied. If copy is `IlTrue`, the data sets are copied. Otherwise, the data sets that are stored in the array dataSets are kept. Therefore, the contents of the array should not be deleted.

Returns: IlTrue if data sets have been set. If not all the data sets could be set, the parameter count is modified to indicate the number of data sets that have been successfully set.

Note: When you set a data set, the new data set is locked and the old one, if any, is unlocked.

Implements IlvAbstractChartData.

§ setMaxDataSetsCount()

void IlvMemoryChartData::setMaxDataSetsCount ( IlUInt maxCount )

Sets the maximum number of data sets that can be managed.

To specify that the number of data sets that can be managed by the current object is not limited, you have to set the maximum data sets count to IlvNoCountLimit.

Parameters

maxCount The new maximum number of data sets that can be managed by the current object.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ IlvMemoryChartData()

§ ~IlvMemoryChartData()

Member Function Documentation

§ addDataSet()

§ getDataSet()

§ getDataSetsCount()

§ getMaxDataSetsCount()

§ insertDataSet()

§ isLimited()

§ removeDataSet()

§ removeDataSets()

§ setDataSet()

§ setDataSets()

§ setMaxDataSetsCount()