HepPDT Reference Documentation

HepPDT

HepPDT::ParticleDataTable Class Reference

#include <ParticleDataTable.hh>

List of all members.

Public Types

typedef ParticleData CPD
typedef std::map< ParticleID,
TempParticleData
TempMap
typedef std::map< ParticleID,
ParticleData, ParticleDataTableComparison
PDTMap
typedef std::map< std::string,
ParticleID
PDTNameMap
typedef PDTMap::const_iterator const_iterator
typedef PDTNameMap::const_iterator const_iteratorByName

Public Member Functions

 ParticleDataTable (std::string name=" ", ProcessUnknownID *=new SimpleProcessUnknownID)
 Require a method to deal with unknown PID's.
 ~ParticleDataTable ()
int size () const
 size of the particle data table
const_iterator begin () const
 begin iterating over the particle data table
const_iterator end () const
 end iterating over the particle data table
int sizeNameMap () const
 size of the map of particle names
const_iteratorByName beginNameMap () const
 begin iterating over the map of particle names
const_iteratorByName endNameMap () const
 end iterating over the map of particle names
std::string tableName () const
 return the name of this particle data table
ParticleData const * particle (ParticleID) const
 access particle information via ParticleID
ParticleDataparticle (ParticleID)
 access particle information via ParticleID
ParticleData const * particle (std::string) const
 access particle information via a particle name
ParticleDataparticle (std::string)
 access particle information via a particle name
ParticleDataoperator[] (ParticleID)
 access particle information via ParticleID
ParticleData const * operator[] (ParticleID) const
 access particle information via ParticleID
ParticleDataoperator[] (std::string)
 access particle information via a particle name
ParticleData const * operator[] (std::string) const
 access particle information via a particle name
void writeParticleData (std::ostream &outstr)
 output all information in the PDT
void writeParticleInfo (std::ostream &outstr)
 output all information about a particle EXCEPT its decays
void writeParticleTranslation (std::ostream &outstr)
 output a list of original IDs and their translations
void writeParticleStatus (std::ostream &)
 primarily useful for testing
void convertTemporaryMap (TempMap &tempPDT, std::ostream &err)
 used by the TableBuilder destructor to fill the PDT


Detailed Description

Author:
Lynn Garren, Walter Brown
Examples:

examMyPDT.cc, listEvtGenNames.cc.in, listPDGNames.cc.in, listPythiaNames.cc.in, testHepPDT.cc, testReadEvtGen.cc.in, testReadIsajet.cc.in, testReadParticleTable.cc.in, and testReadQQ.cc.in.

Definition at line 44 of file ParticleDataTable.hh.


Member Typedef Documentation

typedef PDTMap::const_iterator HepPDT::ParticleDataTable::const_iterator

Definition at line 53 of file ParticleDataTable.hh.

typedef PDTNameMap::const_iterator HepPDT::ParticleDataTable::const_iteratorByName

Definition at line 54 of file ParticleDataTable.hh.

typedef ParticleData HepPDT::ParticleDataTable::CPD

Definition at line 47 of file ParticleDataTable.hh.

typedef std::map<ParticleID,ParticleData,ParticleDataTableComparison> HepPDT::ParticleDataTable::PDTMap

Definition at line 50 of file ParticleDataTable.hh.

typedef std::map<std::string,ParticleID> HepPDT::ParticleDataTable::PDTNameMap

Definition at line 51 of file ParticleDataTable.hh.

typedef std::map<ParticleID,TempParticleData> HepPDT::ParticleDataTable::TempMap

Definition at line 49 of file ParticleDataTable.hh.


Constructor & Destructor Documentation

HepPDT::ParticleDataTable::ParticleDataTable ( std::string  name = " ",
ProcessUnknownID = new SimpleProcessUnknownID 
)

Require a method to deal with unknown PID's.

Definition at line 18 of file ParticleDataTable.cc.

References HepPDT::version().

HepPDT::ParticleDataTable::~ParticleDataTable (  ) 


Member Function Documentation

const_iterator HepPDT::ParticleDataTable::begin (  )  const [inline]

begin iterating over the particle data table

Definition at line 68 of file ParticleDataTable.hh.

Referenced by writeParticleData(), writeParticleInfo(), writeParticleStatus(), and writeParticleTranslation().

const_iteratorByName HepPDT::ParticleDataTable::beginNameMap (  )  const [inline]

begin iterating over the map of particle names

Definition at line 74 of file ParticleDataTable.hh.

void HepPDT::ParticleDataTable::convertTemporaryMap ( TempMap tempPDT,
std::ostream &  err 
)

used by the TableBuilder destructor to fill the PDT

Definition at line 17 of file convertTemporaryMap.cc.

Referenced by HepPDT::TableBuilder::~TableBuilder().

const_iterator HepPDT::ParticleDataTable::end (  )  const [inline]

end iterating over the particle data table

Definition at line 70 of file ParticleDataTable.hh.

Referenced by writeParticleData(), writeParticleInfo(), writeParticleStatus(), and writeParticleTranslation().

const_iteratorByName HepPDT::ParticleDataTable::endNameMap (  )  const [inline]

end iterating over the map of particle names

Definition at line 76 of file ParticleDataTable.hh.

ParticleData const* HepPDT::ParticleDataTable::operator[] ( std::string   )  const

access particle information via a particle name

ParticleData* HepPDT::ParticleDataTable::operator[] ( std::string   ) 

access particle information via a particle name

ParticleData const* HepPDT::ParticleDataTable::operator[] ( ParticleID   )  const

access particle information via ParticleID

ParticleData* HepPDT::ParticleDataTable::operator[] ( ParticleID   ) 

access particle information via ParticleID

ParticleData * HepPDT::ParticleDataTable::particle ( std::string   ) 

access particle information via a particle name

Definition at line 177 of file ParticleDataTable.cc.

References particle().

ParticleData const * HepPDT::ParticleDataTable::particle ( std::string   )  const

access particle information via a particle name

Definition at line 188 of file ParticleDataTable.cc.

References particle().

ParticleData * HepPDT::ParticleDataTable::particle ( ParticleID   ) 

access particle information via ParticleID

Definition at line 141 of file ParticleDataTable.cc.

ParticleData const * HepPDT::ParticleDataTable::particle ( ParticleID   )  const

access particle information via ParticleID

Examples:
examMyPDT.cc, testHepPDT.cc, and testReadParticleTable.cc.in.

Definition at line 153 of file ParticleDataTable.cc.

Referenced by duplicateFragmentTest(), main(), particle(), pdtFragmentTest(), pdtSimpleTest(), HepPDT::TestNuclearFragment::processUnknownID(), HepPDT::HeavyIonUnknownID::processUnknownID(), and testPDMethods().

int HepPDT::ParticleDataTable::size (  )  const [inline]

size of the particle data table

Definition at line 66 of file ParticleDataTable.hh.

Referenced by writeParticleData(), writeParticleInfo(), and writeParticleStatus().

int HepPDT::ParticleDataTable::sizeNameMap (  )  const [inline]

size of the map of particle names

Definition at line 72 of file ParticleDataTable.hh.

std::string HepPDT::ParticleDataTable::tableName (  )  const [inline]

return the name of this particle data table

Definition at line 78 of file ParticleDataTable.hh.

Referenced by writeParticleData(), writeParticleInfo(), and writeParticleStatus().

void HepPDT::ParticleDataTable::writeParticleData ( std::ostream &  outstr  ) 

output all information in the PDT

Examples:
examMyPDT.cc, testHepPDT.cc, testReadEvtGen.cc.in, testReadIsajet.cc.in, testReadParticleTable.cc.in, and testReadQQ.cc.in.

Definition at line 25 of file ParticleDataTable.cc.

References begin(), end(), size(), tableName(), and HepPDT::writeVersion().

Referenced by duplicateFragmentTest(), main(), and pdtSimpleTest().

void HepPDT::ParticleDataTable::writeParticleInfo ( std::ostream &  outstr  ) 

output all information about a particle EXCEPT its decays

Examples:
testHepPDT.cc, and testReadIsajet.cc.in.

Definition at line 51 of file ParticleDataTable.cc.

References begin(), end(), size(), tableName(), and HepPDT::writeVersion().

Referenced by pdtSimpleTest().

void HepPDT::ParticleDataTable::writeParticleStatus ( std::ostream &   ) 

primarily useful for testing

This routine writes the particle name, ID, charge, mass, width,

lifetime, and the results of isStable().

Examples:
testReadParticleTable.cc.in.

Definition at line 88 of file ParticleDataTable.cc.

References begin(), end(), size(), tableName(), and HepPDT::versionName().

Referenced by duplicateFragmentTest().

void HepPDT::ParticleDataTable::writeParticleTranslation ( std::ostream &  outstr  ) 

output a list of original IDs and their translations

Examples:
listEvtGenNames.cc.in, listPDGNames.cc.in, listPythiaNames.cc.in, and testReadQQ.cc.in.

Definition at line 77 of file ParticleDataTable.cc.

References begin(), and end().


The documentation for this class was generated from the following files:
Generated on Fri Dec 4 14:05:25 2009 for HepPDT by  doxygen 1.4.7