File: PDTable.h

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

This is the definition of the HepPDTable class.

The HepPDTable class implements the actual particle property data base in CLHEP. HepPDTable handles all HepParticleData, HepParticleMatcher, HepDecayMode, and HepPackageHandler objects to be used in a program.

The main member is the std::map of pointers to all HepParticleData objects indexed by their STDHEP id numbers. Pointers to HepParticleData objects can be retrieved by their STDHEP id number, but also by its name or according to a user defined numbering scheme used by a package. Pointers to HepParticleMatcher objects can similarly be retrieved by their name.

HepPDTable is not persistent. Instead it can be read and written to a file using a specified ascii format. Since neither the HepParticledata or HepDecayMode classes are polymorphic, all standard particle properties and decay modes can easily be handled this way. User defined HepParticleMatcher objects, however, are polymorphic and must therefore be instanciated and added to the HepDTable before any files are read where the name of the objects is encountered. In the same way, all HepPackageHandler objects must be instanciated and added to HepPDTable by hand and these objects must be able to instanciate all HepPatricleProducer and HepDecayModel objects stored in a file.

All HepParticleData, HepParticleMatcher, HepDecayMode and HepPackageHandler objects added to HepPDTable must be allocated by new and will be deleted by HepPDTable upon destruction.

In addition HepPDTable handles parameters used by different packages which are accessed by their package id number and a package specific name.

After any changes has been made to HepPDTable, the init() method must be called to set up all cross references and check the consistency.

PDT.h ParticleData.h ParticleMatcher.h DecayMode.h PackageHandler.h

Leif Lönnblad

class HepPDT;

typedef map<HepLong, HepParticleData *,
  less<HepLong> > ParticleMap;
typedef map<HepString, HepParticleMatcher *,
  less<HepString> > MatcherMap;
typedef map<HepPkg, HepPackageHandler *,
  less<HepPkg> > PackageMap;
typedef map<HepString, HepDecayMode *,
  less<HepString> > ModeMap;
typedef map<HepString, HepLong,
  less<HepString> > NameMap;
typedef map<HepLong, HepLong,
  less<HepLong> > LongLongMap;
typedef map<HepPkg, LongLongMap,
  less<HepPkg> > TranslationMap;
typedef map<HepString, HepPkg,
  less<HepString> > PackageNameMap;
typedef map<HepString, HepDouble,
  less<HepString> > ParameterMap;
typedef map<HepPkg, ParameterMap,
  less<HepPkg> > PackageParameterMap;

HepPDTable();
The default constructor. Can only be called from the HepPDT class.

HepDecayMode * constructDecayMode(HepString &);

~HepPDTable();
The destructor.

void init();
Initialize the table, set up all cross references correctly. This is done automatically after a read call and shoulc be done manually if any information is changed in the table.

ostream & write(ostream &) const;
istream & read(istream &);
void readPDGFormat(istream &);
Read and write methods. The first two uses the internal ascii format, while readPDGFormat reads the machine readable files provided by the Particle Data Group. Note that for objects of HepParticleMatcher and HepPackageHandler, only their name is written, therefore the necessary objects must be added to the HepPDTable before anything is read.

void add(HepParticleData &);
void add(HepParticleMatcher &);
HepPkg add(HepPackageHandler &);
Add particle data, particle matcher or a package handler object to the PDG table. The objects must have been allocated with new and will be deleted together with the PDTable. If an object with the same id is found it will be deleted and replaced by this one.

inline const HepParticleData *
  getParticleData(HepLong) const;
inline const HepParticleProducer *
  getParticleProducer(HepPkg, HepLong) const;
inline const HepParticleData *
  getParticleData(const HepString &) const;
inline const HepParticleProducer *
  getParticleProducer(HepPkg, const HepString &) const;
inline HepParticleData * getParticleData(HepLong);
inline HepParticleData * getParticleData(const HepString &);
inline const HepParticleMatcher *
  getParticleMatcher(const HepString &) const;
inline HepParticleMatcher * getParticleMatcher(const HepString &);
Retreve a particle data or particle matcher object corresponding to the STDHEP id or character string name. Returns 0 if no corresponding object is found. For the particle data method, the character string is first translated into a number and the particle data object with the corresponding id is returned if found. For the particle producer method, the id number is first translated into a STDHEP number, the correspondig particle data object then returns the producer object corresponding to the package number.

inline HepDecayMode * getDecayMode(const HepString &);
inline const HepDecayMode *
  getDecayMode(const HepString &) const;
Return a decay mode corresponding to the given string tag. If no such decay mode exists the non-const method will create one (and returns 0 on failior), while the second returns 0. If the given string is inconsistent, eg. the product specifications are in the wrong order, the const method will return 0 while the non-const one will try to reconstruct a correct tag.

inline const HepParticleData *
  getParticleData(HepLong, HepPkg) const;
Retrieve a particle data object according to a id of a numbering scheme used by the package indicated by the second argument.

inline const ParticleMap & particles() const;
inline const MatcherMap & matchers() const;
inline const PackageMap & packages() const;
inline const ModeMap & modes() const;
Access to all stuff within the table.

inline HepPkg packageNumber(const HepString &) const;
Return the number used internally for the given package name.

inline HepPackageHandler *
  packageHandler(const HepString &) const;
inline HepPackageHandler * packageHandler(HepPkg) const;
Return a package handle corresponding to the given name or number.

inline HepDouble globalParameter(HepPkg, const HepString &) const;
inline void globalParameter(HepPkg, const HepString &, HepDouble);
Get/set a global parameter for a given package and a given name.

void dumpEnumNames(ostream &) const;
Take all particle names and translate them to something that can be used as a c++ identifier and write a file defining an enum assiciating each identifier with the corresponding STDHEP id number.

ParticleMap allParticles;
A map of pointers to all HepParticleData objects indexed by their STDHEP id numbers.

MatcherMap allMatchers;
A map of pointers to all HepParticleMatcher objects indexed by their names.

PackageMap allPackages;
A map of pointers to all HepPackageHandler objects indexed by their given id number.

ModeMap allModes;
A map of pointers to all HepDecayMode objects indexed by their tag.

NameMap mapName2Stdhep;
A map of all STDHEP id numbers indexed by the standard name of the corresponding particle.

TranslationMap map2stdhep;
A map of a map of STDHEP id numbers indexed by a corresponding number of an alternative numbering scheme indexed by the package id number with the alternative numbering schene.

PackageNameMap packageNumbers;
A map of all package name id numbers indexed by the corresponding name.

PackageParameterMap globalParameters;
A map of a map of parameter values indexed by the corresponding parameter name indexed by the package number.

CLASS DECLARATIONS

class ostream
class istream

DEFINED MACROS

HepPDTable_H_INCLUDED
inline

INCLUDED FILES

CLHEP/PDT/ParticleMatcher.h
CLHEP/PDT/PackageHandler.h
map
CLHEP/PDT/PDTable.icc