IlvCallbackChartFunction Class Reference

Class for data sets described by a callback function. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvCallbackChartFunction:

Public Member Functions
	IlvCallbackChartFunction (const char *name=0, IlvPointInfoCollection *ptInfoCollection=0)
	Initializes a new IlvCallbackChartFunction object. More...
	IlvCallbackChartFunction (const IlvCoordInterval &xRange, IlUInt count, IlvDoubleFunction f, const char *name=0, IlvPointInfoCollection *ptInfoCollection=0)
	Initializes a new IlvCallbackChartFunction object. More...
IlvDoubleFunction	getFunction () const
	Returns the function used to describe the data points. More...
virtual void	getPoint (IlUInt i, IlvDoublePoint &point) const
	Returns a data point. More...
virtual IlBoolean	isFunctionDefined () const
	Indicates whether the function describing the data is defined. More...
void	setFunction (IlvDoubleFunction function)
	Sets the function used to describe the data points. More...
Public Member Functions inherited from IlvAbstractChartFunction
virtual IlUInt	getDataCount () const
	Returns the number of defined data items. More...
IlDouble	getXMax () const
	Returns the maximum value considered for the abscissa. More...
IlDouble	getXMin () const
	Returns the minimum value considered for the abscissa. More...
virtual IlBoolean	isIncreasingOnX () const
	Indicates whether the managed data has increasing abscissa values. More...
void	setDataCount (IlUInt count)
	Sets the number of considered data points. More...
void	setXMax (IlDouble max)
	Sets the maximum value considered for the abscissa. More...
void	setXMin (IlDouble min)
	Sets the minimum value considered for the abscissa. 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 IlvChartDataSet *	copy () 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...
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 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 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...
virtual IlBoolean	setPoint (IlUInt ptidx, const IlvDoublePoint &point)
	Sets a represented data point. 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 IlvAbstractChartFunction
	IlvAbstractChartFunction (const char *name=0, IlvPointInfoCollection *ptInfoCollection=0)
	Initializes a new IlvAbstractChartFunction object. More...
	IlvAbstractChartFunction (const IlvCoordInterval &xRange, IlUInt count, const char *name=0, IlvPointInfoCollection *ptInfoCollection=0)
	Initializes a new IlvAbstractChartFunction object. More...
	IlvAbstractChartFunction (IlvInputFile &file)
	Initializes a new IlvAbstractChartFunction object from an input file. More...
	IlvAbstractChartFunction (const IlvAbstractChartFunction &dataSet)
	Initializes a new IlvAbstractChartFunction object as a copy of another IlvAbstractChartFunction. 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 for data sets described by a callback function.

Library: ilvcharts
This class is a subclass of IlvAbstractChartFunction for which the data points are described by a function of the type y = f(x) defined by a callback. The used callback must be of the type IlvDoubleFunction.

The abscissa of the nth data point of the data set is obtained by the following formula:

x = ((_xMax - _xMin) / (_dataCount -1)) * i + _xMin,

where _xMin and _xMax are the minimum and the maximum values considered for the abscissa and _dataCount is the number of considered data points. The ordinate is equal to f(x).

See also

IlvAbstractChartFunction, IlvDoubleFunction, IlvPointInfoCollection.

Constructor & Destructor Documentation

IlvCallbackChartFunction() [1/2]

IlvCallbackChartFunction::IlvCallbackChartFunction	(	const char *	name = 0,
		IlvPointInfoCollection *	ptInfoCollection = 0
	)

Initializes a new IlvCallbackChartFunction object.

The function and the data count are set by default to 0.

Parameters

name	If not 0, this string becomes the name of the created data set. The name passed as a parameter is copied.
ptInfoCollection	The object used to manage the point information for the created data set.

IlvCallbackChartFunction() [2/2]

IlvCallbackChartFunction::IlvCallbackChartFunction	(	const IlvCoordInterval &	xRange,
		IlUInt	count,
		IlvDoubleFunction	f,
		const char *	name = 0,
		IlvPointInfoCollection *	ptInfoCollection = 0
	)

Initializes a new IlvCallbackChartFunction object.

Parameters

xRange	The values interval considered for the abscissa.
count	The data count.
f	The function used to define the data points.
name	If not 0, this string becomes the name of the created data set. The name passed as a parameter is copied.
ptInfoCollection	The object used to manage the point information of the created data set.

Member Function Documentation

getFunction()

IlvDoubleFunction IlvCallbackChartFunction::getFunction

(

)

const

Returns the function used to describe the data points.

Returns

The function used to describe the data points for the considered data set.

Note

This function is a callback of the type IlvDoubleFunction.

getPoint()

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

virtual

Returns a data point.

Returns in point the point of index i for the current data set. This point is defined as follows:

IlDouble x = ((_xMax - _xMin) / ( _dataCount -1)) * i + _xMin;
IlDouble y = _function ? _function(x) : _yMin;
point.x(x);
point.y(y);

where _xMin and _xMax are the minimum and the maximum values considered for the abscissa, _dataCount is the number of considered data points, _function the defined function, and _yMin the minimum value of the ordinate for all the considered data.

Parameters

i	The index of the returned data point.
point	The returned data point.

Implements IlvChartDataSet.

isFunctionDefined()

virtual IlBoolean IlvCallbackChartFunction::isFunctionDefined ( ) const

virtual

Indicates whether the function describing the data is defined.

Returns

IlTrue if the function describing the data is defined and IlFalse otherwise.

Reimplemented from IlvAbstractChartFunction.

setFunction()

void IlvCallbackChartFunction::setFunction

(

IlvDoubleFunction

function

)

Sets the function used to describe the data points.

Parameters

function

The new function used to describe the data points of the current data set. This function should be a callback of the type IlvDoubleFunction.