Class defining a combined data set used by high-low displayers. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvHiLoChartDataSet:

Public Member Functions
virtual IlUInt	getIndexInCombined (const IlvChartDataSet *dataSet, IlUInt indexInDataSet) const
	Maps a point index in a component data set to an index in the combined data set. More...

virtual IlUInt	getIndexInDataSet (IlvChartDataSet *&dataSet, IlUInt indexInCombined) const
	Maps a point index in the current combined data set to an index in a component data set. More...

virtual void	getPoint (IlUInt i, IlvDoublePoint &point) const
	Returns a represented data point. More...

virtual IlBoolean	retrieveDataSetPoint (IlvChartDataSet *&dataSet, IlUInt ptidx, const IlvDoublePoint &point, IlUInt &dataSetPtIndex, IlvDoublePoint &dataSetPt) const
	Retrieves from a data point of the current combined data set the corresponding data point of a component data set. More...

virtual void	setDataCount (IlUInt count)
	Sets the number of considered data points from the number of data items considered in the component data sets. More...

Public Member Functions inherited from IlvCombinedChartDataSet
void	addDataSet (IlvChartDataSet *dataSet)
	Adds a component data set to the combined data set. More...

virtual IlUInt	getDataCount () const
	Returns the number of considered data points. More...

IlvChartDataSet *	getDataSet (IlUInt index=0) const
	Returns a component data set of the combined data set. More...

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

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

virtual const IlvCoordInterval &	getXRange () const
	Returns the abscissa bounding values of the managed data. More...

virtual const IlvCoordInterval &	getYRange () const
	Returns the ordinate bounding values of the managed data. More...

virtual void	insertDataSet (IlvChartDataSet *dataSet, IlUInt index=0)
	Inserts a component data set into a combined data set. More...

virtual IlBoolean	isIncreasingOnX () const
	Indicates whether the managed data items have increasing abscissa values. More...

virtual void	removeDataSet (IlUInt index=0)
	Removes a component data set from the combined data set. More...

void	removeDataSets ()
	Removes all the component data sets from the combined data set. More...

virtual void	setDataSet (IlvChartDataSet *dataSet, IlUInt index=0)
	Sets a component data set of the combined data set. More...

virtual IlBoolean	setPoint (IlUInt ptidx, const IlvDoublePoint &point)
	Propagates the change made to a given data point of the combined data set to the component data sets. More...

virtual void	updateDataCount ()
	Updates the number of considered data points. More...

virtual IlBoolean	useDataSet (const IlvChartDataSet *dataSet) const
	Indicates whether a data set is one of the data sets that make up the combined data set. More...

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

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

void	addListener (IlvChartDataSetListener *listener)
	Adds a listener. More...

IlBoolean	addPoint (const IlvDoublePoint &point, IlvChartDataPointInfo *pointInfo=0, IlBoolean copyPointInfo=IlFalse)
	Adds a represented data point (and its associated point information object if any). More...

IlBoolean	areListenersEnabled () const
	Indicates whether the listeners are enabled. More...

virtual IlvChartDataSet *	copy () const =0
	Virtual copy constructor. More...

virtual void	dataAllPointsRemoved ()
	Performs the necessary updates when all data points are removed. More...

virtual void	dataPointAdded (IlUInt position)
	Performs the necessary updates when a new data point is added. More...

virtual void	dataPointChanged (IlUInt ptidx, IlBoolean beforeChange)
	Performs the necessary updates when a data point is changed. More...

virtual void	dataPointRemoved (IlUInt ptidx)
	Performs the necessary updates when a data point is removed. More...

void	enableListeners (IlBoolean b)
	Specifies whether the listeners should be enabled. More...

virtual void	endBatch ()
	Specifies the end of a set of modifications. More...

IlUInt	getAddMaxIdx () const
	Returns the maximum index of the data points that have been added between the first call of the `startBatch()` method and the last call of the `endBatch()` method. More...

IlUInt	getAddMinIdx () const
	Returns the minimum index of the data points that have been added between the first call of the `startBatch()` method and the last call of the `endBatch()` method. More...

void	getBoundingValues (IlvCoordInterval &xRange, IlvCoordInterval &yRange) const
	Returns the bounding values of the managed data. More...

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

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

const char *	getName () const
	Returns the name of the current data set. More...

IlvChartDataPointInfo *	getPointInfo (IlUInt ptidx) const
	Returns the point information associated with a data item. More...

IlvPointInfoCollection *	getPointInfoCollection () const
	Returns the object used to manage the point information. More...

IlUInt	getPointInfoCount () const
	Returns the number of defined point information items. More...

IlvDoublePoint *	getPoints (IlUInt &count) const
	Returns all the represented data points. More...

virtual IlvDoublePoint *	getPointsBetween (IlUInt indexMin, IlUInt indexMax, IlUInt &count) const
	Returns some of the data points represented by the current data set. More...

virtual IlvDoublePoint *	getPointsInRange (IlUInt &count, IlUInt *&dataPointIndexes, const IlvCoordInterval &xRange, const IlvCoordInterval &yRange, IlBoolean needContinuity) const
	Returns a range of data points represented by the current data set. More...

virtual IlBoolean	insertPoint (const IlvDoublePoint &point, IlUInt ptidx, IlvChartDataPointInfo *pointInfo=0, IlBoolean copyPointInfo=IlFalse)
	Inserts a represented data point (and its associated point information object if any). More...

virtual IlBoolean	insertPoints (IlUInt count, const IlvDoublePoint points, IlUInt position=IlvLastPositionIndex, IlvChartDataPointInfo const *pInfos=0, IlBoolean copyPointInfo=IlFalse)
	Inserts several represented data points (and their associated point information objects if any). More...

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

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

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

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

void	removeAllPointInfo ()
	Removes all the defined point information. More...

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

IlvChartDataSetListener *	removeListener (IlvChartDataSetListener *l)
	Removes a listener. More...

void	removeListeners ()
	Removes all the listeners.

virtual IlBoolean	removePointAndInfo (IlUInt ptidx)
	Removes a represented data point (and its associated point information object if any). More...

IlBoolean	removePointInfo (IlUInt ptidx)
	Removes the point information associated with a data item. More...

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

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

void	setMaxCount (IlUInt maxCount)
	Sets the maximum number of managed data items. More...

void	setName (const char *name)
	Sets the name of the current data set. More...

IlBoolean	setPointInfo (IlUInt ptidx, IlvChartDataPointInfo *pointInfo, IlBoolean copyPointInfo=IlFalse)
	Sets the point information associated with a data item. More...

void	setPointInfoCollection (IlvPointInfoCollection *ptic)
	Sets the object used to manage the point information. More...

virtual void	startBatch ()
	Specifies the beginning of a set of modifications. More...

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

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

Protected Member Functions inherited from IlvCombinedChartDataSet
	IlvCombinedChartDataSet ()
	Constructor. More...

	IlvCombinedChartDataSet (IlvInputFile &file)
	Constructor. More...

	IlvCombinedChartDataSet (const IlvCombinedChartDataSet &dataSet)
	Constructor. More...

Protected Member Functions inherited from IlvChartDataSet
	IlvChartDataSet (const char name=0, IlvPointInfoCollection pointInfoCollection=0)
	Constructor. More...

	IlvChartDataSet (const IlvChartDataSet &dataSet)
	Constructor. More...

	IlvChartDataSet (IlvInputFile &file)
	Constructor. More...

void	computeBoundingValues ()
	Computes the bounding values of the managed data. More...

virtual void	computeMinMaxValues (IlvCoordInterval &xRange, IlvCoordInterval &yRange) const
	Computes the abscissa and ordinate bounding values of the managed data. More...

Detailed Description

Class defining a combined data set used by high-low displayers.

Library: ilvcharts

This class is a subclass of IlvCombinedChartDataSet which is used by a high-low displayer to put the data to be displayed into a format that the displayer can display. A high-low-data-set is composed of the alternate data items of the two data sets that are set on the high-low displayer. It consists of the first data item of the first data set followed by the first data item of the second data set, then the second data item of the first data set followed by the second data item of the second data set, and so on.

The following example illustrates a high-low-data-set. The real data sets that are set on a high-low displayer are shown in the left column and the high-low-data-set that is constructed from these data sets is shown in the right column. See the IlvHiLoChartDisplayer class to have more information.

Low-values-data-set	High-low-data-set
(0, 0.7)	(0, 0.7)
(1, 0.6)	(0, 1.3)
(2, 0.9)	(1, 0.6)
High-values-data-set	(1, 0.9)
(0, 1.3)	(2, 0.9)
(1, 0.9)	(2, 1.5)
(2, 1.5)	-

See also: IlvCombinedChartDataSet, IlvHiLoChartDisplayer.

Member Function Documentation

virtual IlUInt IlvHiLoChartDataSet::getIndexInCombined	(	const IlvChartDataSet *	dataSet,
		IlUInt	indexInDataSet
	)		const

virtual

Maps a point index in a component data set to an index in the combined data set.

Maps the point index indexInDataSet in the data set dataSet to an index in the current combined data set.

Parameters

dataSet	The data set considered in the combined data set.
indexInDataSet	The index of the data point in the data set dataSet.

Note: The default implementation returns the same index.

Reimplemented from IlvCombinedChartDataSet.

virtual IlUInt IlvHiLoChartDataSet::getIndexInDataSet	(	IlvChartDataSet *&	dataSet,
		IlUInt	indexInCombined
	)		const

virtual

Maps a point index in the current combined data set to an index in a component data set.

Maps the point index indexInCombined in the current combined data set to an index in the corresponding data set among the data sets that make up the current combined data set.

Parameters

dataSet	This parameter is set to the corresponding data set in the combined data set.
indexInCombined	The index of the point in the combined data set.

Note: The default implementation returns the same index and set dataSet as the first data set in the combined data set.

Reimplemented from IlvCombinedChartDataSet.

virtual void IlvHiLoChartDataSet::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.

Implements IlvChartDataSet.

virtual IlBoolean IlvHiLoChartDataSet::retrieveDataSetPoint	(	IlvChartDataSet *&	dataSet,
		IlUInt	ptidx,
		const IlvDoublePoint &	point,
		IlUInt &	dataSetPointIndex,
		IlvDoublePoint &	dataSetPoint
	)		const

virtual

Retrieves from a data point of the current combined data set the corresponding data point of a component data set.

Note: If no data set is specified (dataSet is equal to 0), dataSet is set to a default data set which is one of the data sets that make up the current combined data set.

Parameters

dataSet	The component data set for which we want to retrieve a data point. This data set is one of the data sets that make up the current combined data set.
ptidx	The index of the data point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
point	The point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
dataSetPointIndex	The index of the retrieved point in the data set dataSet.
dataSetPoint	The retrieved point in the data set dataSet.

Returns: IlTrue if the data point has been successfully retrieved and IlFalse otherwise.

Implements IlvCombinedChartDataSet.

virtual void IlvHiLoChartDataSet::setDataCount ( IlUInt count )

virtual

Sets the number of considered data points from the number of data items considered in the component data sets.

Sets the number of data points considered for the current combined data set. This number is set to the number of data points that can be computed from the component data sets when count data items are considered in each component data set.

Parameters

count The number of data items considered in the data sets that make up the combined data set.

Reimplemented from IlvCombinedChartDataSet.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation