class HepObj

generic object for the HepTuple package

HepObj provides very basic methods for obtaining very basic information (e.g., name, title, id#, directory) about a Hep object. HepObj objects will be instantiated only as part of more comprehensive Hep objects.

The classes derived from this one are intended to cooperate with a a manager class, a derivative of HepFileManager.


Related Classes

#include "HepTuple/HepObj.h"


Accessing class information

Title of the Histogram:
  • string title() const;

    Directory of the Histogram (internal to file manager):
  • string dir() const;

    HepFileManager managing this Histogram:
  • HepFileManager * Manager() const;

    The id (assigned by the manager or user):
  • int id() const;

    The type of the object:
  • char type() const;

    Each class has a static data member named typeId containg it type indentification letter. Only full types (HepNtuple, HepHist1D, HepHist2D, HepHistProf and HepDir, for directories) have one.

    For example HepHist1D::typeId

    Status of the Object:
  • bool isValid() const;

    An object can be invalidated if an Exception was raised and ignored during its operation (however, depending of the case some Exceptions could also be ignored witout problem for the object).

  • Release

    Releasing an object indicates to the HepFileManager that the user is done with it and that it can eventually re-use its memory footprint. Usually the manager will also flush the object to disk (for disk based manager).

  • void release() const;
        Do not use the object after this call!

  • Top | Methods | Related Classes

    Related Classes

    Top | Methods | Related Classes

    Return to Zoom Histograms Package Documentation

    Jason Luther, Walter Brown and Mark Fischler
    Last modified: Thu Sep 4 13:30:05 CDT 1997