HepPDT Reference Documentation

HepPDT

HepPDT::TableBuilder Class Reference

The TableBuilder class is used to construct a ParticleDataTable. More...

#include <TableBuilder.hh>

List of all members.

Public Member Functions

 TableBuilder (ParticleDataTable &table, std::ostream &str=std::cerr)
 create TableBuilder from a ParticleDataTable
 ~TableBuilder ()
 call the ParticleDataTable conversion method upon destruction
TempParticleDatagetParticleData (ParticleID pid)
 create a TempParticleData from a ParticleID
TempParticleDatagetParticleData (std::string const &name)
 create a TempParticleData from a particle name
TempParticleDatagetAntiParticle (ParticleID pid, const std::string &aname)
 create an antiparicle TempParticleData from a ParticleID
void addParticle (TempParticleData const &pd)
 add a TempParticleData to the map
void removeParticle (ParticleID pid)
 remove a TempParticleData from the map
void addAlias (TempAliasData const &ad)
 add alias information to the alias map
bool hasParticleData (std::string const &name)
 check to see if this particle is already defined
bool hasAlias (std::string const &alias)
 check to see if this alias is already defined
bool hasDefinition (std::string const &def)
 check to see if this particle name is already defined
int size () const
 get size of particle data map
int aliasSize () const
 get size of alias map
DefTabledefinitions ()
 get the list of definitions (for EvtGen)
double definition (std::string const &def)
 return a parameter definition (for EvtGen)
TempAliasDataaliasData (std::string const &alias)
 find an entry in the alias map


Detailed Description

The TableBuilder class is used to construct a ParticleDataTable.

Author:
Marc Paterno, Walter Brown, Lynn Garren
Define this class and use the add methods to define a ParticleDataTable. The destructor fills ParticleDataTable from the information in TableBuilder. See the examples for user code.
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 42 of file TableBuilder.hh.


Constructor & Destructor Documentation

HepPDT::TableBuilder::TableBuilder ( ParticleDataTable table,
std::ostream &  str = std::cerr 
) [inline, explicit]

create TableBuilder from a ParticleDataTable

Definition at line 49 of file TableBuilder.hh.

HepPDT::TableBuilder::~TableBuilder (  )  [inline]

call the ParticleDataTable conversion method upon destruction

Definition at line 53 of file TableBuilder.hh.

References HepPDT::ParticleDataTable::convertTemporaryMap().


Member Function Documentation

TempParticleData & HepPDT::TableBuilder::getParticleData ( ParticleID  pid  )  [inline]

create a TempParticleData from a ParticleID

Examples:
examMyPDT.cc.

Definition at line 21 of file TableBuilder.icc.

Referenced by addData(), HepPDT::addEvtGenParticles(), HepPDT::addIsajetParticles(), addParticle(), HepPDT::addParticleTable(), HepPDT::addPDGParticles(), HepPDT::addPythiaParticles(), HepPDT::addQQParticles(), getAntiParticle(), and getParticleData().

TempParticleData & HepPDT::TableBuilder::getParticleData ( std::string const &  name  )  [inline]

create a TempParticleData from a particle name

Definition at line 35 of file TableBuilder.icc.

References getParticleData().

TempParticleData & HepPDT::TableBuilder::getAntiParticle ( ParticleID  pid,
const std::string &  aname 
) [inline]

create an antiparicle TempParticleData from a ParticleID

Definition at line 47 of file TableBuilder.icc.

References HepPDT::TempParticleData::antiparticle(), getParticleData(), HepPDT::ParticleID::pid(), and HepPDT::TempParticleData::tempParticleName.

Referenced by HepPDT::addPythiaParticles().

void HepPDT::TableBuilder::addParticle ( TempParticleData const &  pd  )  [inline]

add a TempParticleData to the map

Examples:
examMyPDT.cc.

Definition at line 83 of file TableBuilder.icc.

References getParticleData(), hasParticleData(), HepPDT::TempParticleData::tempID, and HepPDT::TempParticleData::tempParticleName.

Referenced by addData(), HepPDT::addEvtGenParticles(), and HepPDT::addQQParticles().

void HepPDT::TableBuilder::removeParticle ( ParticleID  pid  )  [inline]

remove a TempParticleData from the map

Examples:
examMyPDT.cc.

Definition at line 68 of file TableBuilder.hh.

Referenced by main().

void HepPDT::TableBuilder::addAlias ( TempAliasData const &  ad  )  [inline]

add alias information to the alias map

Definition at line 91 of file TableBuilder.icc.

References HepPDT::TempAliasData::tempAlias.

Referenced by HepPDT::addEvtGenParticles().

bool HepPDT::TableBuilder::hasParticleData ( std::string const &  name  )  [inline]

check to see if this particle is already defined

Definition at line 71 of file TableBuilder.icc.

Referenced by HepPDT::addEvtGenParticles(), addParticle(), and HepPDT::addQQParticles().

bool HepPDT::TableBuilder::hasAlias ( std::string const &  alias  )  [inline]

check to see if this alias is already defined

Definition at line 77 of file TableBuilder.icc.

Referenced by HepPDT::addEvtGenParticles().

bool HepPDT::TableBuilder::hasDefinition ( std::string const &  def  )  [inline]

check to see if this particle name is already defined

Definition at line 80 of file TableBuilder.hh.

References HepPDT::DefTable::hasDefinition().

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

get size of particle data map

Definition at line 85 of file TableBuilder.hh.

Referenced by HepPDT::addEvtGenParticles(), HepPDT::addIsajetParticles(), HepPDT::addParticleTable(), HepPDT::addPDGParticles(), HepPDT::addPythiaParticles(), and HepPDT::addQQParticles().

int HepPDT::TableBuilder::aliasSize (  )  const [inline]

get size of alias map

Definition at line 87 of file TableBuilder.hh.

Referenced by HepPDT::addEvtGenParticles().

DefTable& HepPDT::TableBuilder::definitions (  )  [inline]

get the list of definitions (for EvtGen)

Definition at line 89 of file TableBuilder.hh.

Referenced by HepPDT::addEvtGenParticles().

double HepPDT::TableBuilder::definition ( std::string const &  def  )  [inline]

return a parameter definition (for EvtGen)

Definition at line 91 of file TableBuilder.hh.

References HepPDT::DefTable::definition().

TempAliasData & HepPDT::TableBuilder::aliasData ( std::string const &  alias  )  [inline]

find an entry in the alias map

Definition at line 97 of file TableBuilder.icc.

Referenced by HepPDT::addEvtGenParticles().


The documentation for this class was generated from the following files:
Generated on Fri Oct 24 13:41:40 2008 for HepPDT by  doxygen 1.5.1-3