Basic user-level interface class for holding and managing a single set of "data points". More...

#include <IDataPointSet.h>

Inheritance diagram for AIDA::IDataPointSet:

Public Member Functions
virtual	~IDataPointSet ()
	Destructor.

virtual IAnnotation &	annotation ()=0
	Get the IAnnotation of the IDataPointSet. More...

virtual const IAnnotation &	annotation () const =0

virtual std::string	title () const =0
	Get the title of the IDataPointSet. More...

virtual bool	setTitle (const std::string &title)=0
	Set the title of the IDataPointSet. More...

virtual int	dimension () const =0
	Get the dimension of the IDataPoints that can be stored in the set. More...

virtual void	clear ()=0
	Remove all the IDataPoints in the set. More...

virtual int	size () const =0
	Get the current size of the IDataPointSet, i.e. More...

virtual IDataPoint *	point (int index)=0
	Get the IDataPoint at a give index in the set. More...

virtual bool	setCoordinate (int coord, const std::vector< double > &val, const std::vector< double > &err)=0
	Set the values and errors of a given coordinate all at once. More...

virtual bool	setCoordinate (int coord, const std::vector< double > &val, const std::vector< double > &errp, const std::vector< double > &errm)=0
	Set the values and errors of a given coordinate all at once. More...

virtual const IDataPoint *	point (int index) const =0

virtual IDataPoint *	addPoint ()=0
	Add a new empty IDataPoint at the end of the set. More...

virtual bool	addPoint (const IDataPoint &point)=0
	Add a copy of an IDataPoint at the end of the set. More...

virtual bool	removePoint (int index)=0
	Remove the IDataPoint at a given index. More...

virtual double	lowerExtent (int coord) const =0
	Get the lower value for a give axis. More...

virtual double	upperExtent (int coord) const =0
	Get the upper value for a give axis. More...

virtual bool	scale (double scaleFactor)=0
	Scales the values and the errors of all the measurements of each point by a given factor. More...

virtual bool	scaleValues (double scaleFactor)=0
	Scales the values of all the measurements of each point by a given factor. More...

virtual bool	scaleErrors (double scaleFactor)=0
	Scales the errors of all the measurements of each point by a given factor. More...

virtual void *	cast (const std::string &className) const =0
	See IManagedObject for a description. More...

Detailed Description

Basic user-level interface class for holding and managing a single set of "data points".

Author: The AIDA team (http://aida.freehep.org/)

Member Function Documentation

virtual IDataPoint* AIDA::IDataPointSet::addPoint ( )

pure virtual

Add a new empty IDataPoint at the end of the set.

Returns: The newly added point.

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::addPoint ( const IDataPoint & point )

pure virtual

Add a copy of an IDataPoint at the end of the set.

Parameters

point The IDataPoint to be added.

Returns: false If the point has the wrong dimension or if the point cannot be added.

Implemented in AIDA::IDataPointSetROOT.

virtual IAnnotation& AIDA::IDataPointSet::annotation ( )

pure virtual

Get the IAnnotation of the IDataPointSet.

Returns: The IAnnotation.

Implemented in AIDA::IDataPointSetROOT.

virtual void* AIDA::IDataPointSet::cast ( const std::string & className ) const

pure virtual

See IManagedObject for a description.

Parameters

className The name of the class to cast on.

Returns: The right pointer. Return 0 if failure.

Implemented in AIDA::IDataPointSetROOT.

virtual void AIDA::IDataPointSet::clear ( )

pure virtual

Remove all the IDataPoints in the set.

After this the IDataPointSet is as just created.

Implemented in AIDA::IDataPointSetROOT.

virtual int AIDA::IDataPointSet::dimension ( ) const

pure virtual

Get the dimension of the IDataPoints that can be stored in the set.

Returns: The dimension of the IDataPoints storable in the set.

Implemented in AIDA::IDataPointSetROOT.

virtual double AIDA::IDataPointSet::lowerExtent ( int coord ) const

pure virtual

Get the lower value for a give axis.

Parameters

coord The coordinate of the axis.

Returns: The lower edge of the corresponding axis. If coord < 0 or coord >= dimension(), or if the set is empty NaN is returned.

Implemented in AIDA::IDataPointSetROOT.

virtual IDataPoint* AIDA::IDataPointSet::point ( int index )

pure virtual

Get the IDataPoint at a give index in the set.

Parameters

index The IDataPoint index.

Returns: The corresponding IDataPoint.

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::removePoint ( int index )

pure virtual

Remove the IDataPoint at a given index.

Parameters

index The index of the IDataPoint to be removed.

Returns: false If the index is < 0 or >= size().

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::scale ( double scaleFactor )

pure virtual

Scales the values and the errors of all the measurements of each point by a given factor.

Parameters

scaleFactor The scale factor.

Returns: false If an illegal scaleFactor is provided.

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::scaleErrors ( double scaleFactor )

pure virtual

Scales the errors of all the measurements of each point by a given factor.

Parameters

scaleFactor The scale factor.

Returns: false If an illegal scaleFactor is provided.

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::scaleValues ( double scaleFactor )

pure virtual

Scales the values of all the measurements of each point by a given factor.

Parameters

scaleFactor The scale factor.

Returns: false If an illegal scaleFactor is provided.

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::setCoordinate	(	int	coord,
		const std::vector< double > &	val,
		const std::vector< double > &	err
	)

pure virtual

Set the values and errors of a given coordinate all at once.

If this method is called on an empty IDataPointSet, a number of points equal to the size of the arrays provided is created; if the IDataPointSet is not empty the dimension of the array must match with the size of the IDataPointSet.

Parameters

coord	The coordinate's index
val	The array of the values for the given coordinate
err	The array with the symmetric errors.

Returns: false if an illegal coordinate is provided or if there is a mismatch between the size of the array and the size of the IDataPointSet.

Implemented in AIDA::IDataPointSetROOT.

virtual bool AIDA::IDataPointSet::setCoordinate	(	int	coord,
		const std::vector< double > &	val,
		const std::vector< double > &	errp,
		const std::vector< double > &	errm
	)

pure virtual

Set the values and errors of a given coordinate all at once.

If this method is called on an empty IDataPointSet, a number of points equal to the size of the arrays provided is created; if the IDataPointSet is not empty the dimension of the array must match with the size of the IDataPointSet.

Parameters