#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 28 of file ParticleProperty.h.

Constructor & Destructor Documentation

◆ ParticleProperty() [1/2]

ParticleProperty::ParticleProperty ( )

default

Constructors.

◆ ParticleProperty() [2/2]

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 33 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::~ParticleProperty ( )

default

Destructor.

Member Function Documentation

◆ antiParticle()

const ParticleProperty* ParticleProperty::antiParticle ( ) const

inline

get the pointer to the antiparticle

Definition at line 109 of file ParticleProperty.h.

109 { return m_anti; }

◆ charge()

double ParticleProperty::charge ( ) const

inline

Get the particle charge.

Definition at line 73 of file ParticleProperty.h.

73 { return m_charge; }

◆ evtGenName()

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

inline

Get the EvtGen name.

Definition at line 91 of file ParticleProperty.h.

91 { return m_evtgenName; }

◆ geantID()

int ParticleProperty::geantID ( ) const

inline

Get the GEANT3 ID.

Definition at line 55 of file ParticleProperty.h.

55 { return m_idgeant; }

◆ jetsetID()

int ParticleProperty::jetsetID ( ) const

inline

Get the JETSET(StdHep) ID.

Definition at line 67 of file ParticleProperty.h.

67 { return m_idjetset; }

◆ lifetime()

double ParticleProperty::lifetime ( ) const

inline

Get the particle lifetime.

Definition at line 85 of file ParticleProperty.h.

85 { return m_tlife; }

◆ mass()

double ParticleProperty::mass ( ) const

inline

Get the particle mass.

Definition at line 79 of file ParticleProperty.h.

79 { return m_mass; }

◆ maxWidth()

double ParticleProperty::maxWidth ( ) const

inline

Get the max width deviation.

Definition at line 103 of file ParticleProperty.h.

103 { return m_maxWidth; }

◆ particle()

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

inline

Get the particle name.

Definition at line 49 of file ParticleProperty.h.

49 { return m_name; }

◆ pdgID()

int ParticleProperty::pdgID ( ) const

inline

Get the PDG (= JETSET) ID.

Definition at line 61 of file ParticleProperty.h.

61 { return m_idjetset; }

◆ pythiaID()

int ParticleProperty::pythiaID ( ) const

inline

Get the Pythia ID.

Definition at line 97 of file ParticleProperty.h.

97 { return m_pythiaId; }

◆ setAntiParticle()

void ParticleProperty::setAntiParticle ( const ParticleProperty * p )

inline

set the pointer to the antiparticle

Definition at line 111 of file ParticleProperty.h.

111 { m_anti = p; }

◆ setCharge()

void ParticleProperty::setCharge ( double q )

inline

Set the particle charge.

Definition at line 76 of file ParticleProperty.h.

76 { m_charge = q; }

◆ setEvtGenName()

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

inline

Set the EvtGen name.

Definition at line 94 of file ParticleProperty.h.

94 { m_evtgenName = name; }

◆ setGeantID()

void ParticleProperty::setGeantID ( int id )

inline

Set the GEANT3 ID.

Definition at line 58 of file ParticleProperty.h.

58 { m_idgeant = id; }

◆ setJetsetID()

void ParticleProperty::setJetsetID ( int id )

inline

Set the JETSET(StdHep) ID.

Definition at line 70 of file ParticleProperty.h.

70 { m_idjetset = id; }

◆ setLifetime()

void ParticleProperty::setLifetime ( double t )

inline

Set the particle lifetime.

Definition at line 88 of file ParticleProperty.h.

88 { m_tlife = t; }

◆ setMass()

void ParticleProperty::setMass ( double m )

inline

Set the particle charge.

Definition at line 82 of file ParticleProperty.h.

82 { m_mass = m; }

◆ setMaxWidth()

void ParticleProperty::setMaxWidth ( double mW )

inline

Set the max width deviation.

Definition at line 106 of file ParticleProperty.h.

106 { m_maxWidth = mW; }

◆ setParticle()

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

inline

Set the particle name.

Definition at line 52 of file ParticleProperty.h.

52 { m_name = particle; }

◆ setPdgID()

void ParticleProperty::setPdgID ( int id )

inline

Set the PDG (= JETSET) ID.

Definition at line 64 of file ParticleProperty.h.

64 { m_idjetset = id; }

◆ setPythiaID()

void ParticleProperty::setPythiaID ( int pId )

inline

Set the Pythia ID.

Definition at line 100 of file ParticleProperty.h.

100 { m_pythiaId = pId; }

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 113 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

◆ m_anti

const ParticleProperty* ParticleProperty::m_anti = nullptr

private

the antiparticle

Definition at line 150 of file ParticleProperty.h.

◆ m_charge

double ParticleProperty::m_charge

private

The charge.

Definition at line 132 of file ParticleProperty.h.

◆ m_evtgenName

std::string ParticleProperty::m_evtgenName

private

The EvtGen Name.

Definition at line 141 of file ParticleProperty.h.

◆ m_idgeant

int ParticleProperty::m_idgeant

private

The GEANT ID.

Definition at line 126 of file ParticleProperty.h.

◆ m_idjetset

int ParticleProperty::m_idjetset

private

The Jetset ID.

Definition at line 129 of file ParticleProperty.h.

◆ m_mass

double ParticleProperty::m_mass

private

The mass.

Definition at line 135 of file ParticleProperty.h.

◆ m_maxWidth

double ParticleProperty::m_maxWidth

private

The maximum width deviation.

Definition at line 147 of file ParticleProperty.h.

◆ m_name

std::string ParticleProperty::m_name

private

The particle name.

Definition at line 123 of file ParticleProperty.h.

◆ m_pythiaId

int ParticleProperty::m_pythiaId

private

The Pythia ID.

Definition at line 144 of file ParticleProperty.h.

◆ m_tlife

double ParticleProperty::m_tlife

private

The lifetime.

Definition at line 138 of file ParticleProperty.h.

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

GaudiKernel/include/GaudiKernel/ParticleProperty.h

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ParticleProperty() [1/2]

◆ ParticleProperty() [2/2]

◆ ~ParticleProperty()

Member Function Documentation

◆ antiParticle()

◆ charge()

◆ evtGenName()

◆ geantID()

◆ jetsetID()

◆ lifetime()

◆ mass()

◆ maxWidth()

◆ particle()

◆ pdgID()

◆ pythiaID()

◆ setAntiParticle()

◆ setCharge()

◆ setEvtGenName()

◆ setGeantID()

◆ setJetsetID()

◆ setLifetime()

◆ setMass()

◆ setMaxWidth()

◆ setParticle()

◆ setPdgID()

◆ setPythiaID()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ m_anti

◆ m_charge

◆ m_evtgenName

◆ m_idgeant

◆ m_idjetset

◆ m_mass

◆ m_maxWidth

◆ m_name

◆ m_pythiaId

◆ m_tlife