IlvAbstractChartFunction Class Reference

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

#include <ilviews/charts/data.h>

Inheritance diagram for IlvAbstractChartFunction:

List of all members.

Public Member Functions
virtual IlUInt	getDataCount () const
	Returns the number of defined data items.
IlDouble	getXMax () const
	Returns the maximum value considered for the abscissa.
IlDouble	getXMin () const
	Returns the minimum value considered for the abscissa.
virtual IlBoolean	isFunctionDefined () const
	Indicates whether the function is defined.
virtual IlBoolean	isIncreasingOnX () const
	Indicates whether the managed data has increasing abscissa values.
void	setDataCount (IlUInt count)
	Sets the number of considered data points.
void	setXMax (IlDouble max)
	Sets the maximum value considered for the abscissa.
void	setXMin (IlDouble min)
	Sets the minimum value considered for the abscissa.
virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file.
Protected Member Functions
	IlvAbstractChartFunction (const IlvAbstractChartFunction &dataSet)
	Constructor.
	IlvAbstractChartFunction (IlvInputFile &file)
	Constructor.
	IlvAbstractChartFunction (const IlvCoordInterval &xRange, IlUInt count, const char *name=0, IlvPointInfoCollection *ptInfoCollection=0)
	Constructor.
	IlvAbstractChartFunction (const char *name=0, IlvPointInfoCollection *ptInfoCollection=0)
	Constructor.

---

Detailed Description

Class for data sets described by a function.

Library: ilvcharts

This class is an abstract subclass of IlvChartDataSet for which the data points are described by a function of the type y = f(x).

The abscissa of the nth data point of this 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. The ordinate is equal to f(x).

Warning:

[note] IlvAbstractChartFunction is an abstract class. Its constructors are defined as protected because it is not possible to create an instance of this class directly.

See also:

IlvChartDataSet, IlvCallbackChartFunction, IlvScriptChartFunction, IlvPointInfoCollection, IlvChartDataPointInfo.

---

Constructor & Destructor Documentation

IlvAbstractChartFunction::IlvAbstractChartFunction	(	const char *	name = 0,
		IlvPointInfoCollection *	ptInfoCollection = 0
	)			[protected]

Constructor.

Initializes a new IlvAbstractChartFunction object. By default, the data count is set 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.

IlvAbstractChartFunction::IlvAbstractChartFunction	(	const IlvCoordInterval &	xRange,
		IlUInt	count,
		const char *	name = 0,
		IlvPointInfoCollection *	ptInfoCollection = 0
	)			[protected]

Constructor.

Initializes a new IlvAbstractChartFunction object.

Parameters:

	xRange	The values interval considered for the abscissa.
	count	The data count.
	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.

IlvAbstractChartFunction::IlvAbstractChartFunction

(

IlvInputFile &

file

)

[protected]

Constructor.

Initializes a new IlvAbstractChartFunction object from the description read in the input file named file.

Parameters:

file

The file used to initialize the current data set.

IlvAbstractChartFunction::IlvAbstractChartFunction

(

const IlvAbstractChartFunction &

dataSet

)

[protected]

Constructor.

Initializes a new IlvAbstractChartFunction object as a copy of dataSet.

Parameters:

dataSet

The data set used to initialize the current one.

---

Member Function Documentation

virtual IlUInt IlvAbstractChartFunction::getDataCount

(

)

const [virtual]

Returns the number of defined data items.

Returns:

The number of data items (points or values) defined for the data set.

Implements IlvChartDataSet.

IlDouble IlvAbstractChartFunction::getXMax

(

)

const

Returns the maximum value considered for the abscissa.

Returns:

The maximum value considered for the abscissa.

Warning:

[note] This value is used to compute the data points represented by the current data set.

IlDouble IlvAbstractChartFunction::getXMin

(

)

const

Returns the minimum value considered for the abscissa.

Returns:

The minimum value considered for the abscissa.

Warning:

[note] This value is used to compute the data points represented by the current data set.

virtual IlBoolean IlvAbstractChartFunction::isFunctionDefined

(

)

const [virtual]

Indicates whether the function is defined.

Returns:

IlFalse by default since the function is not defined at this level of the class hierarchy, but only in the derived classes.

Reimplemented in IlvCallbackChartFunction, and IlvScriptChartFunction.

virtual IlBoolean IlvAbstractChartFunction::isIncreasingOnX

(

)

const [virtual]

Indicates whether the managed data has increasing abscissa values.

Returns:

IlTrue by default. The data has an increasing abscissa by definition since the data abscissa correspond to increasing values between the minimum and the maximum values considered for the abscissa.

See also:

IlvAbstractChartFunction::getXMin, IlvAbstractChartFunction::getXMax.

Reimplemented from IlvChartDataSet.

void IlvAbstractChartFunction::setDataCount

(

IlUInt

count

)

Sets the number of considered data points.

Parameters:

count

The new number of data points that are considered for the data set.

void IlvAbstractChartFunction::setXMax

(

IlDouble

max

)

Sets the maximum value considered for the abscissa.

This value is used to compute the data points represented by the current data set.

Parameters:

max

The new maximum value considered for the abscissa.

void IlvAbstractChartFunction::setXMin

(

IlDouble

min

)

Sets the minimum value considered for the abscissa.

This value is used to compute the data points represented by the current data set.

Parameters:

min

The new minimum value considered for the abscissa.

virtual void IlvAbstractChartFunction::write

(

IlvOutputFile &

file

)

const [virtual]

Writes the attributes of the current object in a file.

Called by the IlvChartDataSet::save method. This method can be overloaded in subclasses that define new attributes. The information written by the write method is read by the IO constructor, which takes an IlvInputFile as its only argument. Both this method and the IO constructor can be automatically declared by using the DeclareChartDataSetTypeInfo macro within the class declaration.

Parameters:

file

The file where the attributes of the current object are written.

Reimplemented from IlvChartDataSet.

Reimplemented in IlvScriptChartFunction.