Rogue Wave Views 5.5.1 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
Class for data sets described by a set of values. More...
#include <ilviews/charts/data.h>
Public Member Functions | |
IlvChartYValueSet (const char *name=0, IlvPointInfoCollection *ptInfoCollection=0) | |
Constructor. | |
virtual | ~IlvChartYValueSet () |
Destructor. | |
IlBoolean | addValue (IlDouble yValue, IlvChartDataPointInfo *pointInfo=0, IlBoolean copyPointInfo=IlFalse) |
Adds a data value (and its associated point information object if any). | |
virtual IlUInt | getDataCount () const |
Returns the number of defined data items. | |
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. | |
void | getValue (IlUInt i, IlDouble &yValue) const |
Returns a data value. | |
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). | |
IlBoolean | insertValue (IlDouble yValue, IlUInt valueIndex, IlvChartDataPointInfo *pointInfo=0, IlBoolean copyPointInfo=IlFalse) |
Inserts a data value (and its associated point information object if any). | |
IlBoolean | insertValues (IlUInt count, const IlDouble *yValues, IlUInt position=IlvLastPositionIndex, IlvChartDataPointInfo *const *pInfos=0, IlBoolean copyPointInfo=IlFalse) |
Inserts several values (and their associated point information objects if any). | |
virtual IlBoolean | isIncreasingOnX () const |
Indicates whether the managed data has increasing abscissa values. | |
virtual IlBoolean | removePointAndInfo (IlUInt ptidx) |
Removes a represented data point (and its associated point information if any). | |
virtual void | removePointsAndInfo () |
Removes all the represented data points (and their associated point information objects if any). | |
IlBoolean | removeValueAndInfo (IlUInt valueIndex) |
Removes a data value (and their associated point information objects if any). | |
virtual void | removeValuesAndInfo () |
Removes all the data values (and their associated point information objects if any). | |
virtual IlBoolean | setPoint (IlUInt ptidx, const IlvDoublePoint &point) |
Sets a represented data point. | |
IlBoolean | setValue (IlUInt valueIndex, IlDouble yValue) |
Sets a data value. | |
Protected Member Functions | |
virtual void | computeMinMaxValues (IlvCoordInterval &xRange, IlvCoordInterval &yRange) const |
Computes the abscissa and ordinate bounding values of the managed data. | |
void | updateBoundingValues (IlDouble newYValue) |
Updates the bounding values of the managed data. |
Class for data sets described by a set of values.
Library: ilvcharts
This class is a subclass of IlvChartDataSet
in which the data points are described by values of type IlDouble
stored in an array. These values correspond to the ordinates of the data points. The abscissa of the data points are by definition the indexes of the stored data values.
Example of data that can be represented by an IlvChartYValueSet
object:
X | Y |
0 | 1.2 |
1 | 3.1 |
2 | 4.6 |
IlDouble
instance within the IlvChartYValueSet
object. The X values are not stored, they correspond to the indexes of the stored Y values.IlvChartYValueSet::IlvChartYValueSet | ( | const char * | name = 0 , |
|
IlvPointInfoCollection * | ptInfoCollection = 0 | |||
) |
Constructor.
Initializes a new IlvChartYValueSet
object.
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. |
virtual IlvChartYValueSet::~IlvChartYValueSet | ( | ) | [virtual] |
Destructor.
The destructor removes all the data values managed by the current data set if the removal is allowed (see the IlvChartDataSet::isRemovalAllowed
method).
IlBoolean IlvChartYValueSet::addValue | ( | IlDouble | yValue, | |
IlvChartDataPointInfo * | pointInfo = 0 , |
|||
IlBoolean | copyPointInfo = IlFalse | |||
) |
Adds a data value (and its associated point information object if any).
yValue | The new data value to add. | |
pointInfo | The point information associated with the new data value. This point information is locked. | |
copyPointInfo | A Boolean value indicating whether the point information passed as a parameter must be copied. If copyPointInfo is IlTrue , the point information is copied. Otherwise, a pointer to the point information stored in pointInfo is kept and so its contents should not be deleted. |
IlTrue
if the value and its associated point information have been successfully added and IlFalse
otherwise.IlvChartDataSet::dataPointAdded
method is called within this method after adding the value in order to perform the updates needed because of the change to the data set. virtual void IlvChartYValueSet::computeMinMaxValues | ( | IlvCoordInterval & | xRange, | |
IlvCoordInterval & | yRange | |||
) | const [protected, virtual] |
Computes the abscissa and ordinate bounding values of the managed data.
Computes and returns in xRange and yRange the abscissa and ordinate bounding values of the data managed by the current data set.
xRange | The bounding values for the abscissa of the data managed by the current data set. | |
yRange | The bounding values for the ordinate of the data managed by the current data set. |
IlvChartDataSet::computeBoundingValues
method. Reimplemented from IlvChartDataSet.
virtual IlUInt IlvChartYValueSet::getDataCount | ( | ) | const [virtual] |
Returns the number of defined data items.
Implements IlvChartDataSet.
virtual void IlvChartYValueSet::getPoint | ( | IlUInt | i, | |
IlvDoublePoint & | point | |||
) | const [virtual] |
Returns a represented data point.
Returns in point the point corresponding to the data value of index i for the current data set. The ordinate of point corresponds to the data value of index i stored in the data set. The abscissa of point corresponds to i which is the index of the data value.
i | The index of the returned data point. | |
point | The returned data point. |
Implements IlvChartDataSet.
virtual IlvDoublePoint* IlvChartYValueSet::getPointsBetween | ( | IlUInt | indexMin, | |
IlUInt | indexMax, | |||
IlUInt & | count | |||
) | const [virtual] |
Returns some of the data points represented by the current data set.
indexMin | The index of the first returned data point. | |
indexMax | The index of the last returned data point. | |
count | The number of returned points. |
IlPoolOf(Pointer)
and should not be deleted or modified. Reimplemented from IlvChartDataSet.
Returns a data value.
i | The index of the returned data value. | |
yValue | The returned data value. |
virtual IlBoolean IlvChartYValueSet::insertPoint | ( | const IlvDoublePoint & | point, | |
IlUInt | ptidx, | |||
IlvChartDataPointInfo * | pointInfo = 0 , |
|||
IlBoolean | copyPointInfo = IlFalse | |||
) | [virtual] |
Inserts a represented data point (and its associated point information object if any).
Inserts the ordinate of the point stored in point and its associated point information (if any) at the index ptidx of the data set. Only the ordinate of point is considered since the current data set stores only the ordinate (commonly called Y) values.
point | The new data point to insert. | |
ptidx | The index at which the new data point must be inserted. | |
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. If copyPointInfo is IlTrue , the point information is copied. Otherwise, a pointer to the point information stored in pointInfo is kept and so its contents should not be deleted. |
IlTrue
if the value and its associated point information have been successfully inserted and IlFalse
otherwise.IlvChartDataSet::dataPointAdded
method is called within this method after inserting the value in order to perform the updates needed because of the change to the data set.IlvChartDataSet::setPointInfoCollection
method or the constructor IlvChartDataSet::IlvChartDataSet(const char*, IlvPointInfoCollection*)
.) Reimplemented from IlvChartDataSet.
IlBoolean IlvChartYValueSet::insertValue | ( | IlDouble | yValue, | |
IlUInt | valueIndex, | |||
IlvChartDataPointInfo * | pointInfo = 0 , |
|||
IlBoolean | copyPointInfo = IlFalse | |||
) |
Inserts a data value (and its associated point information object if any).
yValue | The new data value to insert. | |
valueIndex | The index at which the new data value must be inserted. | |
pointInfo | The point information associated with the new data value. This point information is locked. | |
copyPointInfo | A Boolean value indicating whether the point information passed as a parameter must be copied. If copyPointInfo is IlTrue , the point information is copied. Otherwise, a pointer to the point information stored in pointInfo is kept and so its contents should not be deleted. |
IlTrue
if the value and its associated point information have been successfully inserted and IlFalse
otherwise.IlvChartDataSet::dataPointAdded
method is called within this method after inserting the value in order to perform the updates needed because of the change to the data set. IlBoolean IlvChartYValueSet::insertValues | ( | IlUInt | count, | |
const IlDouble * | yValues, | |||
IlUInt | position = IlvLastPositionIndex , |
|||
IlvChartDataPointInfo *const * | pInfos = 0 , |
|||
IlBoolean | copyPointInfo = IlFalse | |||
) |
Inserts several values (and their associated point information objects if any).
Inserts an array of values in the data set. This method uses the IlvChartDataSet::startBatch
and IlvChartDataSet::endBatch
methods to ensure that a single notification is sent.
count | The number of values. | |
yValues | The values to insert. | |
position | The index at which the new values are inserted. | |
pInfos | The information associated with the new values. | |
copyPointInfo | A Boolean value indicating whether the point information stored in pInfos must be copied. |
virtual IlBoolean IlvChartYValueSet::isIncreasingOnX | ( | ) | const [virtual] |
Indicates whether the managed data has increasing abscissa values.
IlTrue
by default. The data has an abscissa that increases or stays the same by definition since the data abscissa correspond to the indexes of the values stored in the current data set. Reimplemented from IlvChartDataSet.
Removes a represented data point (and its associated point information if any).
When you remove a point information object, the point information is not deleted but is unlocked (that is, the IlvChartDataPointInfo::unLock
method is called). It will be deleted only when no objects reference it (see the IlvChartDataPointInfo::unLock
method).
ptidx | The index of the data value and of its associated point information (if any) that are removed. |
IlTrue
if the value and its associated point information (if any) have been removed and IlFalse
otherwise.IlvChartDataSet::dataPointRemoved
method is called within this method after removing the value in order to perform the updates needed because of the change to the data set. Reimplemented from IlvChartDataSet.
virtual void IlvChartYValueSet::removePointsAndInfo | ( | ) | [virtual] |
Removes all the represented data points (and their associated point information objects if any).
IlvChartDataPointInfo::unLock
method is called). It will be deleted only when no objects reference it (see the IlvChartDataPointInfo::unLock
method). Reimplemented from IlvChartDataSet.
Removes a data value (and their associated point information objects if any).
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).
valueIndex | The index of the data value and of its associated point information (if any) that are removed. |
IlTrue
if the value and its associated point information (if any) have been removed and IlFalse
otherwise.IlvChartDataSet::dataPointRemoved
method is called within this method after removing the value in order to perform the updates needed because of the change to the data set. virtual void IlvChartYValueSet::removeValuesAndInfo | ( | ) | [virtual] |
Removes all the data values (and their associated point information objects if any).
IlvChartDataPointInfo::unLock
method is called). It will be deleted only when no objects reference it (see the IlvChartDataPointInfo::unLock
method). virtual IlBoolean IlvChartYValueSet::setPoint | ( | IlUInt | ptidx, | |
const IlvDoublePoint & | point | |||
) | [virtual] |
Sets a represented data point.
Sets the ordinate of the point stored in point at the index ptidx for the data set. Only the ordinate of point is considered, since the current data set stores only the ordinate (commonly called Y) values. If a value already exists at this index, it is replaced by the new one. Otherwise, the value is added at the end.
ptidx | The index at which the new data point must be set. | |
point | The new data point to set. |
IlTrue
if the value has been successfully set and IlFalse
otherwise.IlvChartDataSet::dataPointChanged
method is called within this method before and after changing the value in order to perform the updates needed because of the change to the data set. Reimplemented from IlvChartDataSet.
Sets a data value.
If a value already exists at the index valueIndex, it is replaced by the new one. Otherwise, the value is added at the end.
valueIndex | The index at which the new data value must be set. | |
yValue | The new data value to set. |
IlTrue
if the value has been successfully set and IlFalse
otherwise.IlvChartDataSet::dataPointChanged
method is called within this method before and after changing the value in order to perform the updates needed because of the change to the data set. void IlvChartYValueSet::updateBoundingValues | ( | IlDouble | newYValue | ) | [protected] |
Updates the bounding values of the managed data.
Updates the minimum and maximum values of the abscissa and the ordinate for the data managed by the current data set, by taking into account a new data value that has been added.
newYValue | The new value that has been added to the data set. |
IlvChartDataSet::computeBoundingValues
method and only need to be updated in order to take into account a new added data value. © 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.