FreeHEP API
Version v1.2.2

hep.aida.ref.histogram
Class AbstractBaseHistogram

java.lang.Object
  |
  +--hep.aida.ref.event.AIDAObservable
        |
        +--hep.aida.ref.ManagedObject
              |
              +--hep.aida.ref.histogram.AbstractBaseHistogram
All Implemented Interfaces:
hep.aida.IBaseHistogram, hep.aida.dev.IDevManagedObject, hep.aida.IManagedObject
Direct Known Subclasses:
Cloud, Histogram, Profile

public abstract class AbstractBaseHistogram
extends ManagedObject
implements hep.aida.IBaseHistogram


Field Summary
 
Fields inherited from class hep.aida.ref.ManagedObject
fillable
 
Fields inherited from class hep.aida.ref.event.AIDAObservable
isValid
 
Constructor Summary
AbstractBaseHistogram(String name, String title, int dimension)
          Creates a new instance of BaseHistogram.
 
Method Summary
 hep.aida.IAnnotation annotation()
          Get the IAnnotation associated with the histogram.
 int dimension()
          Get the dimension of the histogram.
abstract  int entries()
          Number of in-range entries in the histogram.
 void reset()
          Reset the histogram; as if just created.
 void setAnnotation(hep.aida.IAnnotation annotation)
           
 void setTitle(String title)
          Set the histogram title.
 String title()
          Get the histogram title.
 
Methods inherited from class hep.aida.ref.ManagedObject
getAIDAType, isFillable, name, setFillable, setName
 
Methods inherited from class hep.aida.ref.event.AIDAObservable
addListener, createEvent, fireStateChanged, fireStateChanged, removeListener, setIsValidAfterNotify, setValid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractBaseHistogram

public AbstractBaseHistogram(String name,
                             String title,
                             int dimension)
Creates a new instance of BaseHistogram.

Parameters:
name - The name of the BaseHistogram. See ManagedObject for details.
title - The title of the BaseHistogram.
dimension - The dimension of the BaseHistogram.
Method Detail

title

public String title()
Get the histogram title.

Specified by:
title in interface hep.aida.IBaseHistogram
Returns:
the Histogram title.

setTitle

public void setTitle(String title)
Set the histogram title.

Specified by:
setTitle in interface hep.aida.IBaseHistogram
Parameters:
title - The title.

annotation

public hep.aida.IAnnotation annotation()
Get the IAnnotation associated with the histogram.

Specified by:
annotation in interface hep.aida.IBaseHistogram
Returns:
The IAnnotation.

setAnnotation

public void setAnnotation(hep.aida.IAnnotation annotation)

dimension

public int dimension()
Get the dimension of the histogram.

Specified by:
dimension in interface hep.aida.IBaseHistogram

reset

public void reset()
Reset the histogram; as if just created.

Specified by:
reset in interface hep.aida.IBaseHistogram

entries

public abstract int entries()
Number of in-range entries in the histogram.

Specified by:
entries in interface hep.aida.IBaseHistogram
Returns:
The number of in-range entries.

FreeHEP API
Version v1.2.2

Copyright © 2000-2003 FreeHEP, All Rights Reserved.