Files
geant4/examples/extended/analysis/A01/include/AIDA/IBaseHistogram.h
T
2016-06-08 16:57:27 +02:00

104 lines
3.4 KiB
C++

//
// ********************************************************************
// * DISCLAIMER *
// * *
// * The following disclaimer summarizes all the specific disclaimers *
// * of contributors to this software. The specific disclaimers,which *
// * govern, are listed with their locations in: *
// * http://cern.ch/geant4/license *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. *
// * *
// * This code implementation is the intellectual property of the *
// * GEANT4 collaboration. *
// * By copying, distributing or modifying the Program (or any work *
// * based on the Program) you indicate your acceptance of this *
// * statement, and all its terms. *
// ********************************************************************
//
// -*- C++ -*-
// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
// =========================================================================
#ifndef AIDA_IBASEHISTOGRAM_H
#define AIDA_IBASEHISTOGRAM_H 1
// This file is part of the AIDA library
// Copyright (C) 2002 by the AIDA team. All rights reserved.
// This library is free software and under the terms of the
// GNU Library General Public License described in the LGPL.txt
#include <string>
namespace AIDA {
class IAnnotation;
/**
* User level interface to Histogram.
* Provides the common functionality of the histogram-like classes.
*
* @author The AIDA team (http://aida.freehep.org/)
*
*/
class IBaseHistogram {
public:
/// Destructor.
virtual ~IBaseHistogram() { /* nop */; }
/**
* Get the Histogram's title.
* @return The Histogram's title.
*
*/
virtual const std::string & title() const = 0;
/**
* Set the histogram title.
* @param title The title.
* @return false If title cannot be changed.
*
*/
virtual bool setTitle(const std::string & title) = 0;
/**
* Get the IAnnotation associated with the Histogram.
* @return The IAnnotation.
*
*/
virtual IAnnotation & annotation() = 0;
virtual const IAnnotation & annotation() const = 0;
/**
* Get the Histogram's dimension.
* @return The Histogram's dimension.
*
*/
virtual int dimension() const = 0;
/**
* Reset the Histogram; as if just created.
* @return false If something goes wrong.
*
*/
virtual bool reset() = 0;
/**
* Get the number of in-range entries in the Histogram.
* @return The number of in-range entries.
*
*/
virtual int entries() const = 0;
}; // class
}; // namespace AIDA
#endif /* ifndef AIDA_IBASEHISTOGRAM_H */