ParticleProperty Class Reference

A trivial class to hold information about a single particle properties. More...

#include <GaudiKernel/ParticleProperty.h>

Collaboration diagram for ParticleProperty:

Public Member Functions
	ParticleProperty ()=default
	Constructors. More...
	ParticleProperty (std::string particle, int geantId, int jetsetId, double charge, double mass, double tlife, std::string evtgenName, int pythiaId, double maxWidth)
	~ParticleProperty ()=default
	Destructor. More...
const std::string &	particle () const
	Get the particle name. More...
void	setParticle (const std::string &particle)
	Set the particle name. More...
int	geantID () const
	Get the GEANT3 ID. More...
void	setGeantID (int id)
	Set the GEANT3 ID. More...
int	pdgID () const
	Get the PDG (= JETSET) ID. More...
void	setPdgID (int id)
	Set the PDG (= JETSET) ID. More...
int	jetsetID () const
	Get the JETSET(StdHep) ID. More...
void	setJetsetID (int id)
	Set the JETSET(StdHep) ID. More...
double	charge () const
	Get the particle charge. More...
void	setCharge (double q)
	Set the particle charge. More...
double	mass () const
	Get the particle mass. More...
void	setMass (double m)
	Set the particle charge. More...
double	lifetime () const
	Get the particle lifetime. More...
void	setLifetime (double t)
	Set the particle lifetime. More...
const std::string &	evtGenName () const
	Get the EvtGen name. More...
void	setEvtGenName (const std::string &name)
	Set the EvtGen name. More...
int	pythiaID () const
	Get the Pythia ID. More...
void	setPythiaID (int pId)
	Set the Pythia ID. More...
double	maxWidth () const
	Get the max width deviation. More...
void	setMaxWidth (double mW)
	Set the max width deviation. More...
const ParticleProperty *	antiParticle () const
	get the pointer to the antiparticle More...
void	setAntiParticle (const ParticleProperty *p)
	set the pointer to the antiparticle More...

Private Attributes
std::string	m_name
	The particle name. More...
int	m_idgeant
	The GEANT ID. More...
int	m_idjetset
	The Jetset ID. More...
double	m_charge
	The charge. More...
double	m_mass
	The mass. More...
double	m_tlife
	The lifetime. More...
std::string	m_evtgenName
	The EvtGen Name. More...
int	m_pythiaId
	The Pythia ID. More...
double	m_maxWidth
	The maximum width deviation. More...
const ParticleProperty *	m_anti = nullptr
	the antiparticle More...

Friends
std::ostream &	operator<< (std::ostream &stream, const ParticleProperty &pp)

Detailed Description

A trivial class to hold information about a single particle properties.

All particle properties are accessible through accessor functions

Author

Iain Last,G.Corti

Definition at line 18 of file ParticleProperty.h.

Constructor & Destructor Documentation

ParticleProperty::ParticleProperty ( )

default

Constructors.

ParticleProperty::ParticleProperty ( std::string  particle, int  geantId, int  jetsetId, double  charge, double  mass, double  tlife, std::string  evtgenName, int  pythiaId, double  maxWidth  )

inline

Definition at line 24 of file ParticleProperty.h.

      : m_name( std::move( particle ) )
      , m_idgeant( geantId )
      , m_idjetset( jetsetId )
      , m_charge( charge )
      , m_mass( mass )
      , m_tlife( tlife )
      , m_evtgenName( std::move( evtgenName ) )
      , m_pythiaId( pythiaId )
      , m_maxWidth( maxWidth )
  {
  }

ParticleProperty::~ParticleProperty ( )

default

Destructor.

Member Function Documentation

const ParticleProperty* ParticleProperty::antiParticle ( ) const

inline

get the pointer to the antiparticle

Definition at line 102 of file ParticleProperty.h.

{ return m_anti; }

double ParticleProperty::charge ( ) const

inline

Get the particle charge.

Definition at line 66 of file ParticleProperty.h.

{ return m_charge; }

const std::string& ParticleProperty::evtGenName ( ) const

inline

Get the EvtGen name.

Definition at line 84 of file ParticleProperty.h.

{ return m_evtgenName; }

int ParticleProperty::geantID ( ) const

inline

Get the GEANT3 ID.

Definition at line 48 of file ParticleProperty.h.

{ return m_idgeant; }

int ParticleProperty::jetsetID ( ) const

inline

Get the JETSET(StdHep) ID.

Definition at line 60 of file ParticleProperty.h.

{ return m_idjetset; }

double ParticleProperty::lifetime ( ) const

inline

Get the particle lifetime.

Definition at line 78 of file ParticleProperty.h.

{ return m_tlife; }

double ParticleProperty::mass ( ) const

inline

Get the particle mass.

Definition at line 72 of file ParticleProperty.h.

{ return m_mass; }

double ParticleProperty::maxWidth ( ) const

inline

Get the max width deviation.

Definition at line 96 of file ParticleProperty.h.

{ return m_maxWidth; }

const std::string& ParticleProperty::particle ( ) const

inline

Get the particle name.

Definition at line 42 of file ParticleProperty.h.

{ return m_name; }

int ParticleProperty::pdgID ( ) const

inline

Get the PDG (= JETSET) ID.

Definition at line 54 of file ParticleProperty.h.

{ return m_idjetset; }

int ParticleProperty::pythiaID ( ) const

inline

Get the Pythia ID.

Definition at line 90 of file ParticleProperty.h.

{ return m_pythiaId; }

void ParticleProperty::setAntiParticle ( const ParticleProperty *  p )

inline

set the pointer to the antiparticle

Definition at line 104 of file ParticleProperty.h.

{ m_anti = p; }

void ParticleProperty::setCharge ( double  q )

inline

Set the particle charge.

Definition at line 69 of file ParticleProperty.h.

{ m_charge = q; }

void ParticleProperty::setEvtGenName ( const std::string &  name )

inline

Set the EvtGen name.

Definition at line 87 of file ParticleProperty.h.

{ m_evtgenName = name; }

void ParticleProperty::setGeantID ( int  id )

inline

Set the GEANT3 ID.

Definition at line 51 of file ParticleProperty.h.

{ m_idgeant = id; }

void ParticleProperty::setJetsetID ( int  id )

inline

Set the JETSET(StdHep) ID.

Definition at line 63 of file ParticleProperty.h.

{ m_idjetset = id; }

void ParticleProperty::setLifetime ( double  t )

inline

Set the particle lifetime.

Definition at line 81 of file ParticleProperty.h.

{ m_tlife = t; }

void ParticleProperty::setMass ( double  m )

inline

Set the particle charge.

Definition at line 75 of file ParticleProperty.h.

{ m_mass = m; }

void ParticleProperty::setMaxWidth ( double  mW )

inline

Set the max width deviation.

Definition at line 99 of file ParticleProperty.h.

{ m_maxWidth = mW; }

void ParticleProperty::setParticle ( const std::string &  particle )

inline

Set the particle name.

Definition at line 45 of file ParticleProperty.h.

{ m_name = particle; }

void ParticleProperty::setPdgID ( int  id )

inline

Set the PDG (= JETSET) ID.

Definition at line 57 of file ParticleProperty.h.

{ m_idjetset = id; }

void ParticleProperty::setPythiaID ( int  pId )

inline

Set the Pythia ID.

Definition at line 93 of file ParticleProperty.h.

{ m_pythiaId = pId; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  stream, const ParticleProperty &  pp  )

friend

Definition at line 106 of file ParticleProperty.h.

  {
    stream << "Name : " << pp.m_name << ", Geant ID : " << pp.m_idgeant << ", JetSet ID : " << pp.m_idjetset
           << ", Charge (/e): " << pp.m_charge << ", Mass (MeV): " << pp.m_mass << ", Lifetime (ns): " << pp.m_tlife
           << ", EvtGen Name: " << pp.m_evtgenName << ", Pythia ID: " << pp.m_pythiaId
           << ", Max width deviation (MeV): " << pp.m_maxWidth;
    return stream;
  }

Member Data Documentation

const ParticleProperty* ParticleProperty::m_anti = nullptr

private

the antiparticle

Definition at line 144 of file ParticleProperty.h.

double ParticleProperty::m_charge

private

The charge.

Definition at line 126 of file ParticleProperty.h.

std::string ParticleProperty::m_evtgenName

private

The EvtGen Name.

Definition at line 135 of file ParticleProperty.h.

int ParticleProperty::m_idgeant

private

The GEANT ID.

Definition at line 120 of file ParticleProperty.h.

int ParticleProperty::m_idjetset

private

The Jetset ID.

Definition at line 123 of file ParticleProperty.h.

double ParticleProperty::m_mass

private

The mass.

Definition at line 129 of file ParticleProperty.h.

double ParticleProperty::m_maxWidth

private

The maximum width deviation.

Definition at line 141 of file ParticleProperty.h.

std::string ParticleProperty::m_name

private

The particle name.

Definition at line 117 of file ParticleProperty.h.

int ParticleProperty::m_pythiaId

private

The Pythia ID.

Definition at line 138 of file ParticleProperty.h.

double ParticleProperty::m_tlife

private

The lifetime.

Definition at line 132 of file ParticleProperty.h.

---

The documentation for this class was generated from the following file:

• GaudiKernel/GaudiKernel/ParticleProperty.h