File: PDT.h

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

This is the definition of the HepPDT class and some utilities needed for the classes representing particle properties.

The HepPDT class is the main interface for using the CLHEP particle data table implementation. The actual implementation is contained in the HepPDTable class while the HepPDT class only implements static functions to access the only static instance of the HepPDTable class. All const methods of the HepPDTable class has their direct stait equivalents in HepPDT, while non-const methods has to be accessed indirectly via the theTable() method.

The HepPDT class defined a set of enum's used by the different classes defining the particle data table implementation.

• HepPDT::HepParity for parity information
• HepPDT::HepSpin for spin information
• HepPDT::HepCharge for charge information
• HepPDT::HepColor for color information
• HepPDT::HepParticleCodes for relating identifiers derived from the standard name of the particles with the STDHEP id number.

PDTable.h ParticleData.h ParticleMatcher.h DecayTable.h DecayMode.h PackageHandler.h

Leif Lönnblad

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;
Convenient typedefs.

static HepPDTable & theTable();
Access the underlying object directly;

static ostream & write(ostream &);
static istream & read(istream &);
static 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, HepParticleProducer and HepDecayModel, only their name is written, therefore the necessary objects must be added to the HepPDTable before anything is read.

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

static const HepParticleData *
  getParticleData(HepLong);
static const HepParticleData *
  getParticleData(const HepString &);
static const HepParticleMatcher *
  getParticleMatcher(const HepString &);
Get particle data or particle matcher objects from the current data table. 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.

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

static const HepDecayMode * getDecayMode(const HepString &);
Return a decay mode corresponding to the given string. If no such decay mode exists it returns 0.

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

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

static HepString makeDecayTag(const HepDecayMode & dm);
Take a decay mode and produce a unique tag for the corresponding initial and final state.

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

enum HepParity { PNA = -2, Pnegative = -1, Pminus = -1,
  Punknown = 0, Pundefined = 0, Ppositive = 1, Pplus = 1 };
Definition of enumerated values used for parity information.

enum HepSpin { SNA = -1, Sunknown = 0, Sundefined = 0,
  S0 = 1, S12 = 2, S1 = 3, S32 = 4, S2 = 5,
  S52 = 6, S3 = 7, S72 = 8, S4 = 9 };
Definition of enumerated values used for spin information.

enum HepCharge { Cunknown = -99999, Cundefined = -99999,
  Ccharged = 99999, Cpositive = 90000, Cnegative = -90000,
  Cn3 = -9, Cn2 = -6, Cn53 = -5, Cn43 = -4,
  Cn1 = -3, Cn23 = -2, Cn13 = -1, C0 = 0,
  C13 = 1, C23 = 2, C1 = 3, C43 = 4,
  C53 = 5, C2 = 6, C3 = 9 };
Definition of enumerated values used for charge information.

enum HepColor { colunknown = -1, colundefined = -1,
  col0 = 0, colcolored = 1, col3 = 3, col3bar = -3, col8 = 8 };
Definition of enumerated values used for color information.

static inline HepBoolean charged(HepCharge c);
True if the argument corresponds to a non-zero charge.

static inline HepBoolean positive(HepCharge c);
True if the argument corresponds to a positive charge.

static inline HepBoolean negative(HepCharge c);
True if the argument corresponds to a negative charge.

static inline HepBoolean colored(HepColor c);
True if the argument corresponds to a non-zero color charge.

CLASS DECLARATIONS

class HepPDTable
class HepParticleData
class HepParticleMatcher
class HepDecayMode
class HepPackageHandler
class ostream
class istream

TYPE DEFINITIONS

string HepString;
long HepLong;
bool HepBoolean;
int HepPkg;

DEFINED MACROS

PDT_H_INCLUDED
CLHEP_MAX_MIN_DEFINED
inline

INCLUDED FILES

CLHEP/config/CLHEP.h
string
map
CLHEP/PDT/PackageHandler.h
enums.h
CLHEP/PDT/PDT.icc