HepPDT Reference Documentation

HepPDT

HepPDT::ParticleData Class Reference

The ParticleData class holds data for a single particle in the table. More...

#include <ParticleData.hh>

List of all members.

Public Member Functions

 ParticleData (const TempParticleData &tpd)
 create ParticleData from the temporary information
 ~ParticleData ()
void swap (ParticleData &rhs)
 ParticleData (const ParticleData &orig)
ParticleDataoperator= (const ParticleData &rhs)
const std::string & name () const
 return particle name as defined by user input
const std::string PDTname () const
 return PDG particle name
const std::string & source () const
 the name of the input source
ParticleID ID () const
 return the ParticleID
int pid () const
 return the integer ID
int originalID () const
 return untranslated integer ID
double charge () const
 return charge
double color () const
 color information
SpinState spin () const
 spin information
Measurement mass () const
 mass
Measurement totalWidth () const
 return the total width
double lowerCutoff () const
 lower cutoff of allowed width values
double upperCutoff () const
 upper cutoff of allowed width values
Measurement lifetime () const
 calculate the lifetime
int numConstituents () const
 number of constituent particles (e.g., quarks)
Constituent constituent (unsigned int i) const
 constituent information
ParticleID constituentParticle (unsigned int i) const
 ParticleID for a constituent particle.
ResonanceStructure const resonance () const
 resonance (width) information
void write (std::ostream &os) const
 output information about this particle
void writeParticleInfo (std::ostream &os) const
void writeParticleTranslation (std::ostream &os) const
 output the translation information for this particle
bool isMeson () const
 is this a valid meson?
bool isBaryon () const
 is this a valid baryon?
bool isDiQuark () const
 is this a valid diquark?
bool isHadron () const
 is this a valid hadron?
bool isLepton () const
 is this a valid lepton?
bool isNucleus () const
 is this a valid ion?
bool hasUp () const
 does this particle contain an up quark?
bool hasDown () const
 does this particle contain a down quark?
bool hasStrange () const
 does this particle contain a strange quark?
bool hasCharm () const
 does this particle contain a charm quark?
bool hasBottom () const
 does this particle contain a bottom quark?
bool hasTop () const
 does this particle contain a top quark?
bool isStable () const
 is this particle allowed to decay?
bool operator< (const ParticleData &other) const
 compare masses
bool operator== (const ParticleData &other) const
 use PID and ignore everything else
void setCharge (double chg)
 change the charge
void setColor (double col)
 change color information
void setSpin (const SpinState &spin)
 change spin information
void addConstituent (Constituent c)
 add a constituent particle
void setMass (Measurement const &mass)
 change the mass
void setTotalWidth (Measurement const &width)
 change the total width
void setTotalWidthFromLifetime (Measurement const &lt)
 change the total width using a lifetime
void setLowerCutoff (double cut)
 change the total width lower cutoff
void setUpperCutoff (double cut)
 change the total width upper cutoff


Detailed Description

The ParticleData class holds data for a single particle in the table.

Author:
Lynn Garren
This class holds the basic paritcle data - name, ID, spin, etc. Methods are provided to get various information about the particle. All the particle information is accessed via this class.
Examples:

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

Definition at line 32 of file ParticleData.hh.


Constructor & Destructor Documentation

HepPDT::ParticleData::ParticleData ( const TempParticleData tpd  )  [inline]

create ParticleData from the temporary information

Definition at line 12 of file ParticleData.icc.

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

Definition at line 26 of file ParticleData.icc.

HepPDT::ParticleData::ParticleData ( const ParticleData orig  )  [inline]

Definition at line 42 of file ParticleData.icc.


Member Function Documentation

void HepPDT::ParticleData::swap ( ParticleData rhs  )  [inline]

Definition at line 29 of file ParticleData.icc.

References itsCharge, itsColorCharge, itsID, itsOriginalID, itsParticleName, itsQuarks, itsResonance, itsSource, itsSpin, HepPDT::SpinState::swap(), HepPDT::ParticleID::swap(), and HepPDT::swap().

Referenced by operator=(), and HepPDT::swap().

ParticleData & HepPDT::ParticleData::operator= ( const ParticleData rhs  )  [inline]

Definition at line 54 of file ParticleData.icc.

References swap().

const std::string& HepPDT::ParticleData::name (  )  const [inline]

return particle name as defined by user input

Examples:
examMyPDT.cc, and testHepPDT.cc.

Definition at line 51 of file ParticleData.hh.

Referenced by main(), and testPDMethods().

const std::string HepPDT::ParticleData::PDTname (  )  const [inline]

return PDG particle name

Definition at line 53 of file ParticleData.hh.

References HepPDT::ParticleID::PDTname().

Referenced by writeParticleTranslation().

const std::string& HepPDT::ParticleData::source (  )  const [inline]

the name of the input source

Definition at line 55 of file ParticleData.hh.

ParticleID HepPDT::ParticleData::ID (  )  const [inline]

return the ParticleID

Definition at line 57 of file ParticleData.hh.

int HepPDT::ParticleData::pid (  )  const [inline]

return the integer ID

Examples:
testHepPDT.cc.

Definition at line 59 of file ParticleData.hh.

References HepPDT::ParticleID::pid().

Referenced by testPDMethods(), and writeParticleTranslation().

int HepPDT::ParticleData::originalID (  )  const [inline]

return untranslated integer ID

Definition at line 61 of file ParticleData.hh.

double HepPDT::ParticleData::charge (  )  const [inline]

return charge

Definition at line 63 of file ParticleData.hh.

double HepPDT::ParticleData::color (  )  const [inline]

color information

Definition at line 65 of file ParticleData.hh.

SpinState HepPDT::ParticleData::spin (  )  const [inline]

spin information

Definition at line 67 of file ParticleData.hh.

Referenced by setSpin().

Measurement HepPDT::ParticleData::mass (  )  const [inline]

mass

Definition at line 69 of file ParticleData.hh.

References HepPDT::ResonanceStructure::mass().

Referenced by operator<(), HepPDT::TestNuclearFragment::processUnknownID(), HepPDT::HeavyIonUnknownID::processUnknownID(), setMass(), and write().

Measurement HepPDT::ParticleData::totalWidth (  )  const [inline]

return the total width

Examples:
testHepPDT.cc.

Definition at line 71 of file ParticleData.hh.

References HepPDT::ResonanceStructure::totalWidth().

Referenced by isStable(), and pdtSimpleTest().

double HepPDT::ParticleData::lowerCutoff (  )  const [inline]

lower cutoff of allowed width values

Examples:
testHepPDT.cc.

Definition at line 73 of file ParticleData.hh.

References HepPDT::ResonanceStructure::lowerCutoff().

Referenced by pdtSimpleTest(), and write().

double HepPDT::ParticleData::upperCutoff (  )  const [inline]

upper cutoff of allowed width values

Examples:
testHepPDT.cc.

Definition at line 75 of file ParticleData.hh.

References HepPDT::ResonanceStructure::upperCutoff().

Referenced by pdtSimpleTest(), and write().

Measurement HepPDT::ParticleData::lifetime (  )  const [inline]

calculate the lifetime

Definition at line 77 of file ParticleData.hh.

References HepPDT::ResonanceStructure::lifetime().

Referenced by isStable(), and write().

int HepPDT::ParticleData::numConstituents (  )  const [inline]

number of constituent particles (e.g., quarks)

Definition at line 79 of file ParticleData.hh.

Constituent HepPDT::ParticleData::constituent ( unsigned int  i  )  const [inline]

constituent information

return this constituent if it exists

Definition at line 98 of file ParticleData.icc.

ParticleID HepPDT::ParticleData::constituentParticle ( unsigned int  i  )  const [inline]

ParticleID for a constituent particle.

Definition at line 109 of file ParticleData.icc.

ResonanceStructure const HepPDT::ParticleData::resonance (  )  const [inline]

resonance (width) information

Definition at line 85 of file ParticleData.hh.

void HepPDT::ParticleData::write ( std::ostream &  os  )  const

output information about this particle

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

Definition at line 18 of file write.cc.

References HepPDT::ParticleID::isValid(), lifetime(), lowerCutoff(), HepPDT::ResonanceStructure::mass(), mass(), HepPDT::SpinState::orbAngMom(), HepPDT::ParticleID::pid(), HepPDT::Measurement::sigma(), HepPDT::SpinState::spin(), HepPDT::SpinState::totalSpin(), HepPDT::ResonanceStructure::totalWidth(), upperCutoff(), and HepPDT::Measurement::value().

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

void HepPDT::ParticleData::writeParticleInfo ( std::ostream &  os  )  const

output all information about a particle EXCEPT its decays This method is redundant with write(), but retained for backwards compatibility.

Definition at line 68 of file write.cc.

References write().

void HepPDT::ParticleData::writeParticleTranslation ( std::ostream &  os  )  const

output the translation information for this particle

Definition at line 73 of file write.cc.

References PDTname(), and pid().

bool HepPDT::ParticleData::isMeson (  )  const [inline]

is this a valid meson?

Definition at line 98 of file ParticleData.hh.

References HepPDT::ParticleID::isMeson().

bool HepPDT::ParticleData::isBaryon (  )  const [inline]

is this a valid baryon?

Definition at line 100 of file ParticleData.hh.

References HepPDT::ParticleID::isBaryon().

bool HepPDT::ParticleData::isDiQuark (  )  const [inline]

is this a valid diquark?

Definition at line 102 of file ParticleData.hh.

References HepPDT::ParticleID::isDiQuark().

bool HepPDT::ParticleData::isHadron (  )  const [inline]

is this a valid hadron?

Definition at line 104 of file ParticleData.hh.

References HepPDT::ParticleID::isHadron().

bool HepPDT::ParticleData::isLepton (  )  const [inline]

is this a valid lepton?

Definition at line 106 of file ParticleData.hh.

References HepPDT::ParticleID::isLepton().

bool HepPDT::ParticleData::isNucleus (  )  const [inline]

is this a valid ion?

Definition at line 108 of file ParticleData.hh.

References HepPDT::ParticleID::isNucleus().

bool HepPDT::ParticleData::hasUp (  )  const

does this particle contain an up quark?

Examples:
testHepPDT.cc.

Definition at line 16 of file hasMethods.cc.

Referenced by testPDMethods().

bool HepPDT::ParticleData::hasDown (  )  const

does this particle contain a down quark?

Examples:
testHepPDT.cc.

Definition at line 26 of file hasMethods.cc.

Referenced by testPDMethods().

bool HepPDT::ParticleData::hasStrange (  )  const

does this particle contain a strange quark?

Examples:
testHepPDT.cc.

Definition at line 36 of file hasMethods.cc.

Referenced by testPDMethods().

bool HepPDT::ParticleData::hasCharm (  )  const

does this particle contain a charm quark?

Examples:
testHepPDT.cc.

Definition at line 46 of file hasMethods.cc.

Referenced by testPDMethods().

bool HepPDT::ParticleData::hasBottom (  )  const

does this particle contain a bottom quark?

Examples:
testHepPDT.cc.

Definition at line 56 of file hasMethods.cc.

Referenced by testPDMethods().

bool HepPDT::ParticleData::hasTop (  )  const

does this particle contain a top quark?

Examples:
testHepPDT.cc.

Definition at line 66 of file hasMethods.cc.

Referenced by testPDMethods().

bool HepPDT::ParticleData::isStable (  )  const [inline]

is this particle allowed to decay?

Definition at line 61 of file ParticleData.icc.

References lifetime(), and totalWidth().

bool HepPDT::ParticleData::operator< ( const ParticleData other  )  const [inline]

compare masses

Definition at line 68 of file ParticleData.icc.

References mass().

bool HepPDT::ParticleData::operator== ( const ParticleData other  )  const [inline]

use PID and ignore everything else

Definition at line 73 of file ParticleData.icc.

References itsID.

void HepPDT::ParticleData::setCharge ( double  chg  )  [inline]

change the charge

Definition at line 133 of file ParticleData.hh.

void HepPDT::ParticleData::setColor ( double  col  )  [inline]

change color information

Definition at line 135 of file ParticleData.hh.

void HepPDT::ParticleData::setSpin ( const SpinState spin  )  [inline]

change spin information

Definition at line 137 of file ParticleData.hh.

References spin().

void HepPDT::ParticleData::addConstituent ( Constituent  c  )  [inline]

add a constituent particle

Definition at line 139 of file ParticleData.hh.

void HepPDT::ParticleData::setMass ( Measurement const &  mass  )  [inline]

change the mass

Definition at line 141 of file ParticleData.hh.

References mass(), and HepPDT::ResonanceStructure::setMass().

void HepPDT::ParticleData::setTotalWidth ( Measurement const &  width  )  [inline]

change the total width

Definition at line 143 of file ParticleData.hh.

References HepPDT::ResonanceStructure::setTotalWidth().

void HepPDT::ParticleData::setTotalWidthFromLifetime ( Measurement const &  lt  )  [inline]

change the total width using a lifetime

Definition at line 145 of file ParticleData.hh.

References HepPDT::ResonanceStructure::setTotalWidthFromLifetime().

void HepPDT::ParticleData::setLowerCutoff ( double  cut  )  [inline]

change the total width lower cutoff

Definition at line 147 of file ParticleData.hh.

References HepPDT::ResonanceStructure::setLowerCutoff().

void HepPDT::ParticleData::setUpperCutoff ( double  cut  )  [inline]

change the total width upper cutoff

Definition at line 149 of file ParticleData.hh.

References HepPDT::ResonanceStructure::setUpperCutoff().


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