IlvChartCyclicPointSet Class Reference

Class for data sets described by a cyclic set of points. More...

#include <ilviews/charts/cyclicdata.h>

Inheritance diagram for IlvChartCyclicPointSet:

List of all members.

Public Member Functions
	IlvChartCyclicPointSet (const char *name=0, IlvPointInfoCyclicArray *ptInfoCollection=0)
	Constructor.
virtual	~IlvChartCyclicPointSet ()
	Destructor.
virtual void	dataPointAdded (IlUInt position)
	Performs the updates needed when a new data point is added.
virtual void	getPoint (IlUInt i, IlvDoublePoint &point) const
	Returns a represented data point.
virtual IlvDoublePoint *	getPointsBetween (IlUInt indexMin, IlUInt indexMax, IlUInt &count) const
	Returns some of the data points represented by the current data set.
virtual IlBoolean	insertPoint (const IlvDoublePoint &point, IlUInt pointIndex, IlvChartDataPointInfo *pointInfo=0, IlBoolean copyPointInfo=IlFalse)
	Inserts a represented data point (and its associated point information object, if any).
virtual void	removePointsAndInfo ()
	Removes all the represented data points (and their associated point information objects if any).
virtual IlBoolean	setPoint (IlUInt pointIndex, const IlvDoublePoint &point)
	Sets a represented data point.

---

Detailed Description

Class for data sets described by a cyclic set of points.

Library: ilvcharts

---

Constructor & Destructor Documentation

IlvChartCyclicPointSet::IlvChartCyclicPointSet	(	const char *	name = 0,
		IlvPointInfoCyclicArray *	ptInfoCollection = 0
	)

Constructor.

Initializes a new IlvChartCyclicPointSet object.

Parameters:

	name	If not 0, this string becomes the name of the created data set. The name passed as a parameter is copied.
	pointInfoCollection	The object used to manage the point information for the created data set.

---

Member Function Documentation

virtual void IlvChartCyclicPointSet::dataPointAdded

(

IlUInt

position

)

[virtual]

Performs the updates needed when a new data point is added.

This method first calls the IlvChartDataSet::dataPointAdded method and then updates the flag indicating whether the data managed by the current data set have an abscissa that increases or stays the same, by taking the new data point into account.

Parameters:

position

The index at which the data point is added.

Reimplemented from IlvChartPointSet.

virtual void IlvChartCyclicPointSet::getPoint	(	IlUInt	i,
		IlvDoublePoint &	point
	)			const [virtual]

Returns a represented data point.

Parameters:

	i	The index of the returned data point.
	point	The returned data point.

Reimplemented from IlvChartPointSet.

virtual IlvDoublePoint* IlvChartCyclicPointSet::getPointsBetween	(	IlUInt	indexMin,
		IlUInt	indexMax,
		IlUInt &	count
	)			const [virtual]

Returns some of the data points represented by the current data set.

Parameters:

	indexMin	The index of the first returned data point.
	indexMax	The index of the last returned data point.
	count	The number of returned points.

Returns:

An array of the data points represented by the current data set that are between the indexMin and the indexMax indexes. The array is stored in an IlPoolOf(Pointer) and should not be deleted or modified.

Reimplemented from IlvChartPointSet.

virtual IlBoolean IlvChartCyclicPointSet::insertPoint	(	const IlvDoublePoint &	point,
		IlUInt	pointIndex,
		IlvChartDataPointInfo *	pointInfo = 0,
		IlBoolean	copyPointInfo = IlFalse
	)			[virtual]

Inserts a represented data point (and its associated point information object, if any).

Parameters:

	point	The new data point.
	pointIndex	The index at which the new data point is inserted. Currently, only appending is supported (for example, pointIndex must be greater than the data count).
	pointInfo	The point information associated with the new data point. This point information is locked.
	copyPointInfo	A Boolean value indicating whether the point information passed as a parameter must be copied.

Reimplemented from IlvChartPointSet.

virtual void IlvChartCyclicPointSet::removePointsAndInfo

(

)

[virtual]

Removes all the represented data points (and their associated point information objects if any).

Warning:

[note] When you remove a point information object, the point information is not deleted but unlocked (that is, the IlvChartDataPointInfo::unLock method is called). It will be deleted only when no objects reference it (see the IlvChartDataPointInfo::unLock method).

Reimplemented from IlvChartPointSet.

virtual IlBoolean IlvChartCyclicPointSet::setPoint	(	IlUInt	pointIndex,
		const IlvDoublePoint &	point
	)			[virtual]

Sets a represented data point.

If a point already exists at the index pointIndex, it is replaced by the new one. Otherwise, the new point is added at the end, possibly replacing and old one (depending on how many points were added already).

Parameters:

	pointIndex	The index at which the new data point is set.
	point	The new data point.

Returns:

IlTrue if the point has been successfully set, IlFalse otherwise.

Warning:

[note] If a point already exists at the index pointIndex, the IlvChartDataSet::dataPointChanged method is called within this method before and after the point is changed in order to do the updates needed because of the change to the data set.

Reimplemented from IlvChartPointSet.