CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

               

---

AIDA::IDataPointSet Class Reference

#include <IDataPointSet.h>

List of all members.

Public Methods
virtual	~IDataPointSet ()
	Destructor. More...
virtual IAnnotation&	annotation ()=0
virtual const IAnnotation&	annotation () const=0
virtual const std::string&	title () const=0
virtual bool	setTitle (const std::string &title)=0
virtual int	dimension () const=0
virtual void	clear ()=0
virtual int	size () const=0
virtual IDataPoint*	point (int index)=0
virtual const IDataPoint*	point (int index) const=0
virtual bool	addPoint ()=0
virtual bool	addPoint (const IDataPoint &point)=0
virtual bool	removePoint (int index)=0
virtual double	lowerExtent (int coord) const=0
virtual double	upperExtent (int coord) const=0
virtual bool	scale (double scaleFactor)=0
virtual bool	scaleValues (double scaleFactor)=0
virtual bool	scaleErrors (double scaleFactor)=0

---

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/)

Definition at line 30 of file IDataPointSet.h.

---

Constructor & Destructor Documentation

AIDA::IDataPointSet::~IDataPointSet ( ) [inline, virtual]

Definition at line 34 of file IDataPointSet.h.

---

Member Function Documentation

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.

bool AIDA::IDataPointSet::addPoint ( ) [pure virtual]

Add a new empty IDataPoint at the end of the set. Returns: false If a new IDataPoint cannot be added to the set.

const IAnnotation & AIDA::IDataPointSet::annotation ( ) const [pure virtual]

IAnnotation & AIDA::IDataPointSet::annotation ( ) [pure virtual]

Get the IAnnotation of the IDataPointSet. Returns: The IAnnotation.

void AIDA::IDataPointSet::clear ( ) [pure virtual]

Remove all the IDataPoints in the set. After this the IDataPointSet is as just created.

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.

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.

const IDataPoint * AIDA::IDataPointSet::point ( int index ) const [pure 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.

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().

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.

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.

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.

bool AIDA::IDataPointSet::setTitle ( const std::string & title ) [pure virtual]

Set the title of the IDataPointSet. Parameters: title   The new title. Returns: false If the title cannot be set.

int AIDA::IDataPointSet::size ( ) const [pure virtual]

Get the current size of the IDataPointSet, i.e. the number of IDataPoints contained in the set. Returns: The size of the IDataPointSet.

const std::string & AIDA::IDataPointSet::title ( ) const [pure virtual]

Get the title of the IDataPointSet. Returns: The title.

double AIDA::IDataPointSet::upperExtent ( int coord ) const [pure virtual]

Get the upper value for a give axis. Parameters: coord   The coordinate of the axis. Returns: The upper edge of the corresponding axis. If coord < 0 or coord >= dimension(), or if the set is empty NaN is returned.

---

The documentation for this class was generated from the following file:

• IDataPointSet.h

---