IlvMemoryChartData Class Reference

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

#include <ilviews/charts/data.h>

Inheritance diagram for IlvMemoryChartData:

List of all members.

Public Member Functions
	IlvMemoryChartData ()
	Constructor.
virtual	~IlvMemoryChartData ()
	Destructor.
virtual IlBoolean	addDataSet (IlvChartDataSet *dataSet, IlBoolean copy=IlFalse)
	Adds a managed data set.
virtual IlvChartDataSet *	getDataSet (IlUInt dataSetIndex) const
	Gets a managed data set by its index.
virtual IlUInt	getDataSetsCount () const
	Returns the number of managed data sets.
IlUInt	getMaxDataSetsCount () const
	Returns the maximum number of data sets that can be managed.
virtual IlBoolean	insertDataSet (IlvChartDataSet *dataSet, IlUInt index=IlvLastPositionIndex, IlBoolean copy=IlFalse)
	Inserts a managed data set.
virtual IlBoolean	isLimited () const
	Indicates whether the number of managed data sets is limited.
virtual IlBoolean	removeDataSet (IlUInt dataSetIndex)
	Removes a managed data set.
virtual void	removeDataSets ()
	Removes all the managed data sets.
virtual IlBoolean	setDataSet (IlUInt dataSetIndex, IlvChartDataSet *dataSet, IlBoolean copy=IlFalse)
	Sets a managed data set.
virtual IlBoolean	setDataSets (IlUInt &count, IlvChartDataSet *const *dataSets, IlBoolean copy=IlFalse)
	Sets the managed data sets.
void	setMaxDataSetsCount (IlUInt maxCount)
	Sets the maximum number of data sets that can be managed.

---

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

(

)

Constructor.

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.

virtual IlvMemoryChartData::~IlvMemoryChartData

(

)

[virtual]

Destructor.

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

Warning:

[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

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	A Boolean value indicating 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.

Warning:

[note] When you add a data set, the new data set is locked.

Implements IlvAbstractChartData.

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.

Warning:

[note] The data set object must not be deleted by the user since it is maintained internally.

Implements IlvAbstractChartData.

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.

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.

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	A Boolean value indicating 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.

Warning:

[note] When you insert a data set, the new data set is locked.

Implements IlvAbstractChartData.

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.

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.

Warning:

[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.

virtual void IlvMemoryChartData::removeDataSets

(

)

[virtual]

Removes all the managed data sets.

Warning:

[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.

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	A Boolean value indicating 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.

Warning:

[note] When you set a data set, the new data set is locked and the old one, if it exists, is unlocked.

Implements IlvAbstractChartData.

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	A Boolean value indicating 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.

Warning:

[note] When you set a data set, the new data set is locked and the old one, if any, is unlocked.

Implements IlvAbstractChartData.

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.