File: PackageHandler.h

This file may become a part of CLHEP - a Class Library for High Energy Physics.

This is the definition of the HepPackageHandler, HepDecayModel and HepParticleProducer classes.

The HepPackageHandler class is an abstract base class used to allow the CLHEP particle data table to handle information used by user defined packaged with different particle instanciation schemes and/or models for particle decays. In this way, all the information needed for a program using the CLHEP particle data table can be handled by HepPDTable and can be stored in the same ASCII file as the particle properties handled directly by HepPDTable.

The HepDecayModel is an empty abstract base class intended to keep information needed to perform an actual particle decay and also to perform the decay given an object corresponding to an actual particle instance in the given package.

The HepParticleProducer is an empty abstract base class intended to store package specific information for a particle type and should be able to create an object correponding to an actual particle instance in the given package.

HepPackageHandler have five purely virtual methods which has to be implemented by a derived class.

• name() should return a unique name of the package.
• writeDecayModel(ostream &, const HepDecayModel &) should write the data of a HepDecayModel object so that it can be read again by readDecayModel.
• writeParticleProducer(ostream &, const HepParticleProducer &) should write the data of a HepParticleProducer object so that it can be read again by .B readParticleProducer
• readDecayModel(istream &, const HepDecayMode &) should be able to read information previously written by writeDecayModel and reconstruct and return the corresponding HepDecayModel object.
• readParticleProducer(istream &, const HepParticleData &) should be able to read information previously written by writeParticleProducer and reconstruct and return the corresponding HepParticleProducer object.

Note that while the HepPDTable is responsible for the handeling of HepPackageHandler objects, the class derived from HepPackageHandler is itself responsible for the handeling of corresponding HepParticleProducer and HepDecayModel objects.

PDT.h PDTable.h ParticleMatcher.h PackageHandler.h

Leif Lönnblad

virtual ~HepDecayModel() {}

HepDecayModel() {}

virtual ~HepParticleProducer() {}

HepParticleProducer(const HepParticleData & pd)
  : theData(pd) {}
const HepParticleData & theData;

class HepPDTable;

virtual ~HepPackageHandler() {}
The destructor.

virtual const HepString & name() const = 0;
Returns the name of this package.

virtual HepDecayModel * readDecayModel(istream &, const HepDecayMode &) = 0;
read information from a stream, previously written by writeDecayModel(), construct the corresponding HepDecayModel object and return it.

virtual HepParticleProducer *
  readParticleProducer(istream &, const HepParticleData &) = 0;
read information from a stream, previously written by writeParticleProducer(), construct the corresponding HepParticleProducer object and return it. Note that the Producer object will have a reference to the particle data object and therefore one particle producer object must be created for each particle data object.

virtual void writeDecayModel(ostream &,
  const HepDecayModel &) const = 0;
Write information from a HepDecayModel object so that it can be reconstructed by readDecayModel().

virtual void writeParticleProducer(ostream &,
  const HepParticleProducer &) const = 0;
Write information from a HepParticleProducer object so that it can be reconstructed by readParticleProducer().

HepPkg handlerId() const { return phid; }
Return the package id number given by HepPDTable.

HepPackageHandler() {};

void handlerId(HepPkg id) { phid = id; }
Set the package id number. Is done automatically when added to HepPDTable

HepPkg phid;
The package id number given by HepPDTable.

CLASS DECLARATIONS

class istream
class ostream
class HepParticleData

DEFINED MACROS

PackageHandler_H_INCLUDED

INCLUDED FILES

CLHEP/PDT/PDT.h