IlvPointInfoMap Class Reference

Class for point information objects management. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvPointInfoMap:

Public Member Functions
	IlvPointInfoMap ()
	Initializes a new IlvPointInfoMap object.
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...
virtual void	removeAllPointInfo ()
	Removes all point information. More...
virtual IlBoolean	removePointInfo (IlUInt ptidx)
	Removes the point information for a given data point. More...
virtual void	setPointInfo (IlUInt ptidx, IlvChartDataPointInfo *ptInfo, IlBoolean copy=IlFalse)
	Sets the point information defined for a given data point. 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

Class for point information objects management.

Library: ilvcharts
This class is a subclass of IlvPointInfoCollection that stores the pointers to the point information defined for the data points of a given data set in an array. This class also stores the indexes of the data points with which the point information objects are associated in order to retrieve the point information object associated with a given data point.

Note

The use of an IlvPointInfoMap object to store the point information objects defined for the data points of a given data set is not optimal if there is a point information object defined for each data point of the data set with which the IlvPointInfoMap object is associated. If a point information object is defined for each data point of the data set, it is better to use an IlvPointInfoArray object to store the point information objects defined for the data points of a given data set.

See also

IlvPointInfoCollection, IlvChartDataPointInfo.

Member Function Documentation

getInfoForPoint()

virtual IlvChartDataPointInfo* IlvPointInfoMap::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* IlvPointInfoMap::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 IlvPointInfoMap::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.

removeAllPointInfo()

virtual void IlvPointInfoMap::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 IlvPointInfoMap::removePointInfo ( IlUInt  ptidx )

virtual

Removes the point information for a given data point.

When you remove a point information object, the point information object is not deleted but it 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).

Parameters

ptidx

The index of the data point with which the point information that is removed is associated.

Returns

IlTrue if the point information has been removed and IlFalse otherwise.

Implements IlvPointInfoCollection.

setPointInfo()

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

virtual

Sets the point information defined for a given data point.

If a point information object has already been stored in the current object for the data point at index ptidx, this point information is replaced by ptInfo. The new point information ptInfo is locked.

Parameters

ptidx	The index of the data point for which the point information is set.
ptInfo	The new point information.
copy	Indicates whether the point information passed as a parameter must be copied: If copy is IlTrue, the point information is copied. Otherwise, a pointer to the point information stored in ptInfo is kept and so its contents should not be deleted since it is maintained internally.

Implements IlvPointInfoCollection.