Rogue Wave Views
Charts Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvChartCyclicPointSet Class Reference

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

#include <ilviews/charts/cyclicdata.h>

Inheritance diagram for IlvChartCyclicPointSet:
IlvChartPointSet IlvChartDataSet IlvValueInterface

Public Member Functions

 IlvChartCyclicPointSet (const char *name=0, IlvPointInfoCyclicArray *pointInfoCollection=0)
 Constructor. More...
 
virtual ~IlvChartCyclicPointSet ()
 Destructor.
 
virtual void dataPointAdded (IlUInt position)
 Performs the updates needed when a new data point is added. More...
 
virtual void getPoint (IlUInt i, IlvDoublePoint &point) const
 Returns a represented data point. More...
 
virtual IlvDoublePointgetPointsBetween (IlUInt indexMin, IlUInt indexMax, IlUInt &count) const
 Returns some of the data points represented by the current data set. More...
 
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). More...
 
virtual void removePointsAndInfo ()
 Removes all the represented data points (and their associated point information objects if any). More...
 
virtual IlBoolean setPoint (IlUInt pointIndex, const IlvDoublePoint &point)
 Sets a represented data point. More...
 
- Public Member Functions inherited from IlvChartPointSet
 IlvChartPointSet (const char *name=0, IlvPointInfoCollection *pointInfoCollection=0)
 Constructor. More...
 
virtual ~IlvChartPointSet ()
 Destructor. More...
 
virtual void dataPointChanged (IlUInt ptidx, IlBoolean beforeChange)
 Performs the necessary updates when a data point is changed. More...
 
virtual IlUInt getDataCount () const
 Returns the number of defined data items. 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...
 
virtual IlBoolean isIncreasingOnX () const
 Indicates whether the managed data has increasing abscissa values. More...
 
virtual IlBoolean removePointAndInfo (IlUInt ptidx)
 Removes a represented data point (and its associated point information object if any). 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
 Virtual copy constructor. More...
 
virtual void dataAllPointsRemoved ()
 Performs the necessary updates when all data points are removed. 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 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 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...
 
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.
 
IlBoolean removePointInfo (IlUInt ptidx)
 Removes the point information associated with a data item. 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...
 
virtual void write (IlvOutputFile &file) const
 Writes the attributes of the current object in a file. 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 IlvChartPointSet
virtual void computeMinMaxValues (IlvCoordInterval &xRange, IlvCoordInterval &yRange) const
 Computes the abscissa and ordinate bounding values of the managed data. More...
 
void updateBoundingValues (const IlvDoublePoint &newPoint)
 Updates the bounding values of the managed data. 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...
 

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 *  pointInfoCollection = 0 
)

Constructor.

Initializes a new IlvChartCyclicPointSet object.

Parameters
nameIf not 0, this string becomes the name of the created data set. The name passed as a parameter is copied.
pointInfoCollectionThe 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
positionThe 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
iThe index of the returned data point.
pointThe 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
indexMinThe index of the first returned data point.
indexMaxThe index of the last returned data point.
countThe 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
pointThe new data point.
pointIndexThe index at which the new data point is inserted. Currently, only appending is supported (for example, pointIndex must be greater than the data count).
pointInfoThe point information associated with the new data point. This point information is locked.
copyPointInfoA 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).

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
pointIndexThe index at which the new data point is set.
pointThe new data point.
Returns
IlTrue if the point has been successfully set, IlFalse otherwise.
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.


© Copyright 2016, 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.