---

IHistogram.h

Go to the documentation of this file.

// $Header: /nfs/slac/g/glast/ground/cvs/GaudiKernel/GaudiKernel/IHistogram.h,v 1.1.1.1 2001/04/18 18:14:18 tlindner Exp $
#ifndef INTERFACES_IHISTOGRAM_H
#define INTERFACES_IHISTOGRAM_H 1


// Include files
#include <string>


// Forward declarations
class IAnnotation;


//------------------------------------------------------------------------------
//
// ClassName:    IHistogram
//  
// Description:  Definition of the IHistogram interface class
//
//               IHistogram is a base class for all other histogram interfaces.
//               It contains their common functionality.
//
//               IHistogram is not a complete histogram interface, it cannot
//               be used as a standard histogram.  It is ment to be used e.g.
//               for histogram managment (there, where the number of axes is
//               not important).
//
// Design principles :
//
//  1) Only interfaces, basic types, and types from foundation libraries
//     are allowed (STL is currently the only one foundation library)
//     - Uses only int and double as basic types
//     - Internals (classes, enums, or others) of concrete packages
//       do not appear in the interface
//  2) Accessors - XXX() (no getXXX() functions)
//  3) In member function names
//     - in-range bins are not specified explicitly (e.g. sumBinHeights())
//     - ...All... mean all (in-range and extra) bins (e.g. sumAllBinHeights())
//     - ...Extra... mean extra bins (e.g. sumExtraBinHeights())
//
//
// Authors:      Pavel Binko, Dino Ferrero Merlino, Andreas Pfeiffer
// Date:         22/03/2000
//
//------------------------------------------------------------------------------


class IHistogram {

public:



  enum { UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 };



  virtual std::string title() const                                         = 0;
  virtual void setTitle( std::string value )                                = 0;

//PB  virtual IAnnotation* annotation()                                         = 0;
//PB  virtual const IAnnotation* annotation() const                             = 0;

  virtual int dimensions() const                                            = 0;

  virtual void reset()                                                      = 0;



  virtual int entries() const                                               = 0;

  virtual int allEntries() const                                            = 0;

  virtual int extraEntries() const                                          = 0;

  virtual double equivalentBinEntries() const                               = 0;



  virtual double sumBinHeights() const                                      = 0;

  virtual double sumAllBinHeights() const                                   = 0;

  virtual double sumExtraBinHeights() const                                 = 0;

};


#endif    // INTERFACES_IHISTOGRAM_H

---