CERN Accelerating science

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

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

AIDA::IBaseHistogram Class Reference

#include <IBaseHistogram.h>

Inheritance diagram for AIDA::IBaseHistogram::

AIDA::ICloud AIDA::IHistogram AIDA::IProfile AIDA::ICloud1D AIDA::ICloud2D AIDA::ICloud3D AIDA::IHistogram1D AIDA::IHistogram2D AIDA::IHistogram3D AIDA::IProfile1D AIDA::IProfile2D List of all members.

Public Methods

virtual ~IBaseHistogram ()
 Destructor. More...

virtual const std::string& title () const=0
virtual bool setTitle (const std::string &title)=0
virtual IAnnotationannotation ()=0
virtual const IAnnotationannotation () const=0
virtual int dimension () const=0
virtual bool reset ()=0
virtual int entries () const=0

Detailed Description

User level interface to Histogram. Provides the common functionality of the histogram-like classes.

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

Definition at line 29 of file IBaseHistogram.h.


Constructor & Destructor Documentation

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

Definition at line 33 of file IBaseHistogram.h.


Member Function Documentation

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

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

Get the IAnnotation associated with the Histogram.

Returns:
The IAnnotation.

int AIDA::IBaseHistogram::dimension ( ) const [pure virtual]
 

Get the Histogram's dimension.

Returns:
The Histogram's dimension.

int AIDA::IBaseHistogram::entries ( ) const [pure virtual]
 

Get the number of in-range entries in the Histogram.

Returns:
The number of in-range entries.

bool AIDA::IBaseHistogram::reset ( ) [pure virtual]
 

Reset the Histogram; as if just created.

Returns:
false If something goes wrong.

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

Set the histogram title.

Parameters:
title   The title.
Returns:
false If title cannot be changed.

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

Get the Histogram's title.

Returns:
The Histogram's title.


The documentation for this class was generated from the following file:
Generated at Tue Feb 18 15:48:24 2003 for AIDA_Interfaces by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001