IlvPointInfoSingleton Class Reference

Stores a unique IlvChartDataPointInfo instance. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvPointInfoSingleton:

Public Member Functions
	IlvPointInfoSingleton (IlvChartDataPointInfo *singleton=0)
	Initializes a new IlvPointInfoSingleton object. More...
virtual IlvChartDataPointInfo *	getInfoForPoint (IlUInt ptidx) const
	Returns the point information for a given data point. More...
virtual IlvChartDataPointInfo *	getPointInfo (IlUInt idx) const
	Returns the point information at a given index. More...
virtual IlUInt	getPointInfoCount () const
	Returns the number of point information objects managed by this object. More...
IlvChartDataPointInfo *	getSingleton () const
	Returns the unique point information object. More...
virtual void	removeAllPointInfo ()
	Removes all point information. More...
virtual IlBoolean	removePointInfo (IlUInt ptidx)
	Does nothing. More...
virtual void	setPointInfo (IlUInt ptidx, IlvChartDataPointInfo *ptInfo, IlBoolean copy=IlFalse)
	Does nothing. More...
void	setSingleton (IlvChartDataPointInfo *singleton)
	Sets the unique point information object. More...
Public Member Functions inherited from IlvPointInfoCollection
virtual IlvPointInfoCollection *	copy () const =0
	Creates and returns a copy of the current object. More...
void	lock ()
	Locks the current IlvPointInfoCollection object. More...
IlvOutputFile &	save (IlvOutputFile &file) const
	Writes a complete description of the current object in a file. More...
void	unLock ()
	Unlocks the current IlvPointInfoCollection object. More...
virtual void	write (IlvOutputFile &file) const =0
	Writes the attributes of the current object in a file. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvPointInfoCollection
static IlvPointInfoCollection *	Load (IlvInputFile &file)
	Reads a point information collection object from a file. More...
Protected Member Functions inherited from IlvPointInfoCollection
	IlvPointInfoCollection ()
	Initializes a new IlvPointInfoCollection object.
	IlvPointInfoCollection (const IlvPointInfoCollection &pointInfo)
	Initializes a new IlvPointInfoCollection object as a copy of another IlvPointInfoCollection. More...
	IlvPointInfoCollection (IlvInputFile &file)
	Initializes a new IlvPointInfoCollection object from an input file. More...

Detailed Description

Stores a unique IlvChartDataPointInfo instance.

Library: ilvcharts

This class is a subclass of IlvPointInfoCollection that associates all data points of a given data set with a unique IlvChartDataPointInfo instance.

See also

IlvPointInfoCollection, IlvChartDataPointInfo.

Constructor & Destructor Documentation

IlvPointInfoSingleton()

IlvPointInfoSingleton::IlvPointInfoSingleton

(

IlvChartDataPointInfo *

singleton = 0

)

Initializes a new IlvPointInfoSingleton object.

Parameters

singleton

The unique point information object associated with all the data points of the data set. This point information object is locked.

Member Function Documentation

getInfoForPoint()

virtual IlvChartDataPointInfo* IlvPointInfoSingleton::getInfoForPoint ( IlUInt  pidx ) const

virtual

Returns the point information for a given data point.

Parameters

pidx	The index of the data point with which the returned point information is associated.

Returns

A pointer to the point information associated with the data point at the index pidx in the data set with which the current object is associated. The returned point information should not be deleted since it is maintained internally.

Implements IlvPointInfoCollection.

getPointInfo()

virtual IlvChartDataPointInfo* IlvPointInfoSingleton::getPointInfo ( IlUInt  idx ) const

virtual

Returns the point information at a given index.

Parameters

idx	The index of the returned point information.

Returns

A pointer to the point information at the index idx in the collection of point information objects managed by the current object. The returned point information stores graphical information for a data point of the data set with which the current object is associated. This point information should not be deleted since it is maintained internally.

Implements IlvPointInfoCollection.

getPointInfoCount()

virtual IlUInt IlvPointInfoSingleton::getPointInfoCount ( ) const

virtual

Returns the number of point information objects managed by this object.

Returns

The number of point information objects managed by this object.

Implements IlvPointInfoCollection.

getSingleton()

IlvChartDataPointInfo* IlvPointInfoSingleton::getSingleton

(

)

const

Returns the unique point information object.

Returns

The point information object associated with all the data points of the data set.

removeAllPointInfo()

virtual void IlvPointInfoSingleton::removeAllPointInfo ( )

virtual

Removes all point information.

Removes all the point information objects that are managed by the current object.

Note

When you remove a point information object, the point information object is not deleted but unlocked (that is, the IlvChartDataPointInfo::unLock() method is called). It will be deleted only when no more objects reference it (see the IlvChartDataPointInfo::unLock() method).

Implements IlvPointInfoCollection.

removePointInfo()

virtual IlBoolean IlvPointInfoSingleton::removePointInfo ( IlUInt  ptidx )

virtual

Does nothing.

This method does nothing and returns IlFalse as the point information object is shared by all the data points of the data set.

Implements IlvPointInfoCollection.

setPointInfo()

virtual void IlvPointInfoSingleton::setPointInfo ( IlUInt  ptidx, IlvChartDataPointInfo *  ptInfo, IlBoolean  copy = IlFalse  )

virtual

Does nothing.

This method does nothing as the information object is shared by all the data points of the data set. Use the IlvPointInfoSingleton::setSingleton() method instead.

Implements IlvPointInfoCollection.

setSingleton()

void IlvPointInfoSingleton::setSingleton

(

IlvChartDataPointInfo *

singleton

)

Sets the unique point information object.

The point information object singleton is locked and the previous point information object is unlocked.

Parameters

singleton

The new point information object.