The ParticleType class for identifying different particle types. More...

#include <Const.h>

Inheritance diagram for Const::ParticleType:

Collaboration diagram for Const::ParticleType:

Public Member Functions
	ParticleType (int pdgCode, const ParticleSet *set=nullptr, int index=-1)
	Constructor. More...

	ParticleType (const ParticleType &)=default
	Copy constructor

ParticleType &	operator= (const ParticleType &)=default
	Assignment Operator.

bool	operator< (const ParticleType &other) const
	Comparison operator to be usable in sets. More...

bool	operator== (const ParticleType &o) const
	Test equality.

bool	operator!= (const ParticleType &o) const
	Test inequality.

ParticleType &	operator* ()
	dummy dereferencing for range-based for.

ParticleType &	operator++ ()
	Prefix increment. More...

ParticleType	operator++ (int)
	Postfix increment. More...

	operator ParticleSet () const
	Conversion of ParticleType to ParticleSet.

int	getIndex () const
	This particle's index in the associated set. More...

const TParticlePDG *	getParticlePDG () const
	Accessor for ROOT TParticlePDG object. More...

int	getPDGCode () const
	PDG code. More...

double	getMass () const
	Particle mass. More...

std::string	__repr__ () const
	String for printing in python.

Private Attributes
int	m_pdgCode
	PDG code of the particle.

const ParticleSet *	m_set
	set this particle belongs to, or NULL if stand-alone.

int	m_index
	index in the associated set, -1 if there's no set.

Detailed Description

The ParticleType class for identifying different particle types.

Particle Data Group (PDG) codes are used for specifying types, for a detailed explanation and tables please refer to: https://pdg.web.cern.ch/pdg/2012/mcdata/mc_particle_id_contents.html

Definition at line 399 of file Const.h.

Constructor & Destructor Documentation

◆ ParticleType()

ParticleType	(	int	pdgCode,
		const ParticleSet *	set = `nullptr`,
		int	index = `-1`
	)

inlineexplicit

Constructor.

Parameters

pdgCode	the Particle Data Group code that identifies the particle.
set	Pointer to set this particle belongs to (or NULL if stand-alone).
index	Index of this particle in 'set'.

Definition at line 408 of file Const.h.

Member Function Documentation

◆ getIndex()

int getIndex ( ) const

inline

This particle's index in the associated set.

In case the particle has no set, -1 is returned.

Definition at line 452 of file Const.h.

◆ getMass()

double getMass ( void ) const

Particle mass.

Returns: The mass of the particle.

Definition at line 356 of file UnitConst.cc.

◆ getParticlePDG()

const TParticlePDG * getParticlePDG ( ) const

Accessor for ROOT TParticlePDG object.

Returns: The TParticlePDG object for this type of particle.

Definition at line 351 of file UnitConst.cc.

◆ getPDGCode()

int getPDGCode ( void ) const

inline

PDG code.

Returns: The PDG code of the particle.

Definition at line 464 of file Const.h.

◆ operator++() [1/2]

Const::ParticleType & operator++ ( )

Prefix increment.

Incrementing past the last element of a set will return an invalid particle.

Definition at line 333 of file UnitConst.cc.

◆ operator++() [2/2]

Const::ParticleType operator++ ( int )

Postfix increment.

Incrementing past the last element of a set will yield an invalid particle.

Definition at line 344 of file UnitConst.cc.

◆ operator<()

bool operator< ( const ParticleType & other ) const

Comparison operator to be usable in sets.