Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvAddChartDataSet Class Reference

Class defining a combined data set as the addition of other data sets. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvAddChartDataSet:
IlvCombinedChartDataSet IlvChartDataSet IlvValueInterface

Public Member Functions

virtual void getPoint (IlUInt i, IlvDoublePoint &) const
 Returns a represented data point. More...
 
virtual IlBoolean retrieveDataSetPoint (IlvChartDataSet *&, IlUInt, const IlvDoublePoint &, IlUInt &, IlvDoublePoint &) const
 Retrieves from a data point of the current combined data set the corresponding data point of a component data set. 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...
 
IlvChartDataSetgetDataSet (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 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 const IlvCoordIntervalgetXRange () const
 Returns the abscissa bounding values of the managed data. More...
 
virtual const IlvCoordIntervalgetYRange () 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 setDataCount (IlUInt count)
 Sets the number of considered data points from the number of data items considered in the component data sets. 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 &) 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 IlvChartDataSetcopy () const =0
 Creates and returns a copy of the current object. 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...
 
IlvChartDataPointInfogetPointInfo (IlUInt ptidx) const
 Returns the point information associated with a data item. More...
 
IlvPointInfoCollectiongetPointInfoCollection () const
 Returns the object used to manage the point information. More...
 
IlUInt getPointInfoCount () const
 Returns the number of defined point information items. More...
 
IlvDoublePointgetPoints (IlUInt &count) const
 Returns all the represented data points. More...
 
virtual IlvDoublePointgetPointsBetween (IlUInt indexMin, IlUInt indexMax, IlUInt &count) const
 Returns some of the data points represented by the current data set. More...
 
virtual IlvDoublePointgetPointsInRange (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...
 
IlvChartDataSetListenerremoveListener (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...
 
IlvOutputFilesave (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 IlvChartDataSetLoad (IlvInputFile &file)
 Reads a data set object from a file. More...
 
- Protected Member Functions inherited from IlvCombinedChartDataSet
 IlvCombinedChartDataSet ()
 Initializes a new IlvCombinedChartDataSet object.
 
 IlvCombinedChartDataSet (const IlvCombinedChartDataSet &dataSet)
 Initializes a new IlvCombinedChartDataSet object as a copy of another IlvCombinedChartDataSet. More...
 
 IlvCombinedChartDataSet (IlvInputFile &file)
 Initializes a new IlvCombinedChartDataSet object from an input file. More...
 
- Protected Member Functions inherited from IlvChartDataSet
 IlvChartDataSet (const char *name=0, IlvPointInfoCollection *pointInfoCollection=0)
 Initializes a new IlvChartDataSet object. More...
 
 IlvChartDataSet (const IlvChartDataSet &dataSet)
 Initializes a new IlvChartDataSet object as a copy of another IlvChartDataSet. More...
 
 IlvChartDataSet (IlvInputFile &file)
 Initializes a new IlvChartDataSet object from an input file. 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 as the addition of other data sets.

Library: ilvcharts

This class is a subclass of IlvCombinedChartDataSet which allows you to define a data set as the addition of any number of other data sets. The nth data point of the add-data-set will correspond to the sum of the nth data points of all the real data sets that make up this data set.

This type of data set is used by the stacked displayers to put the data to be displayed into a format that the displayer can display. See the IlvStackedChartDisplayer class to have more information.

The following example illustrates an add-data-set. The real data sets that make up the add-data-set are shown in the left column and the add-data-set that is constructed from these data sets is shown in the right column. The addition is performed only for the Y values as in the stacked displayers, but it can also be performed for the X values.

Data-set-1 Add-data-set
(0, 0.7) (0, 2.0)
(1, 0.6) (1, 1.5)
(2, 0.9) (2, 2.4)
Data-set-2-
(0, 1.3) -
(1, 0.9) -
(2, 1.5) -
See also
IlvCombinedChartDataSet, IlvStackedChartDisplayer.

Member Function Documentation

◆ getPoint()

virtual void IlvAddChartDataSet::getPoint ( IlUInt  i,
IlvDoublePoint point 
) const
virtual

Returns a represented data point.

Parameters
iThe index of the returned data point.
pointThe returned data point.

Implements IlvChartDataSet.

◆ retrieveDataSetPoint()

virtual IlBoolean IlvAddChartDataSet::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
dataSetThe 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.
ptidxThe index of the data point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
pointThe point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
dataSetPointIndexThe index of the retrieved point in the data set dataSet.
dataSetPointThe retrieved point in the data set dataSet.
Returns
IlTrue if the data point has been successfully retrieved and IlFalse otherwise.

Implements IlvCombinedChartDataSet.