rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

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

List of all members.

Public Member Functions

virtual void getPoint (IlUInt i, IlvDoublePoint &point) const
 Returns a represented data point.
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.

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

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

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


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.