HepPDT Reference Documentation

HepPDT

HepPDT::SpinState Class Reference

The SpinState class holds spin information. More...

#include <SpinState.hh>

List of all members.

Public Member Functions

 SpinState (double ts=0., double spin=0., double oam=0.)
 (default) constructor
 SpinState (const SpinState &orig)
SpinStateoperator= (const SpinState &rhs)
void swap (SpinState &other)
bool operator== (const SpinState &rhs) const
 all three spins must match
double totalSpin () const
 return the total spin
double spin () const
 return the spin
double orbAngMom () const
 return the orbital angular momentum
void setTotalSpin (double spin)
 change the total spin
void setSpin (double spin)
 change the spin
void setOrbAngMom (double ang)
 change the orbital angular momentum


Detailed Description

The SpinState class holds spin information.

Author:
Lynn Garren
SpinState contains total spin, spin, and orbital angular momentum.
Examples:

examMyPDT.cc.

Definition at line 20 of file SpinState.hh.


Constructor & Destructor Documentation

HepPDT::SpinState::SpinState ( double  ts = 0.,
double  spin = 0.,
double  oam = 0. 
) [inline]

(default) constructor

Definition at line 11 of file SpinState.icc.

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

Definition at line 17 of file SpinState.icc.


Member Function Documentation

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

Definition at line 23 of file SpinState.icc.

References swap().

void HepPDT::SpinState::swap ( SpinState other  )  [inline]

Definition at line 30 of file SpinState.icc.

References itsOrbAngMom, itsSpin, itsTotalSpin, and HepPDT::swap().

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

bool HepPDT::SpinState::operator== ( const SpinState rhs  )  const [inline]

all three spins must match

Definition at line 36 of file SpinState.icc.

References itsOrbAngMom, itsSpin, and itsTotalSpin.

double HepPDT::SpinState::totalSpin (  )  const [inline]

return the total spin

Definition at line 43 of file SpinState.hh.

Referenced by HepPDT::parseEvtGenLine(), HepPDT::parseQQParticle(), and HepPDT::ParticleData::write().

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

return the spin

Definition at line 45 of file SpinState.hh.

Referenced by HepPDT::ParticleData::write().

double HepPDT::SpinState::orbAngMom (  )  const [inline]

return the orbital angular momentum

Definition at line 47 of file SpinState.hh.

Referenced by HepPDT::ParticleData::write().

void HepPDT::SpinState::setTotalSpin ( double  spin  )  [inline]

change the total spin

Definition at line 52 of file SpinState.hh.

Referenced by HepPDT::parseEvtGenLine(), HepPDT::parseQQParticle(), and HepPDT::TempParticleData::processPID().

void HepPDT::SpinState::setSpin ( double  spin  )  [inline]

change the spin

Definition at line 54 of file SpinState.hh.

Referenced by HepPDT::TempParticleData::processPID().

void HepPDT::SpinState::setOrbAngMom ( double  ang  )  [inline]

change the orbital angular momentum

Definition at line 56 of file SpinState.hh.

Referenced by HepPDT::TempParticleData::processPID().


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