Herd::MCParticle Class Reference

Description of a Monte Carlo particle. More...

#include <dataobjects/MCParticle.h>

Inheritance diagram for Herd::MCParticle:

Public Member Functions
	MCParticle ()
	Default constructor. More...
	MCParticle (Point position, Momentum momentum)
	Construct a new MCParticle object. More...
	MCParticle (float initialTime, int pdgCode, Point position, Momentum momentum)
	Construct a new MCParticle object. More...
virtual	~MCParticle ()=default
	Virtual destructor More...
float	InitialTime () const
	Get the time of generation of the particle. More...
int	PDGCode () const
	Get the PDG code of the particle. More...
Point	InitialPosition () const
	Get the generation position of the particle. More...
Vec3D	InitialMomentum () const
	Get the generation momentum of the particle. More...
Line	InitialTrajectory () const
	Get the generation trajectory of the particle. More...

Private Attributes
float	m_initialTime
	Generation time of the particle in the MC simulation [ns]. More...
int	m_pdgCode
	PDG code of the particle. More...
Point	m_initialPosition
	Initial position vector. More...
Vec3D	m_initialMomentum
	Initial momentum vector. More...

Detailed Description

Description of a Monte Carlo particle.

Constructor & Destructor Documentation

MCParticle() [1/3]

Herd::MCParticle::MCParticle ( )

inline

Default constructor.

MCParticle() [2/3]

Herd::MCParticle::MCParticle ( Point  position, Momentum  momentum  )

inline

Construct a new MCParticle object.

MCParticle() [3/3]

Herd::MCParticle::MCParticle ( float  initialTime, int  pdgCode, Point  position, Momentum  momentum  )

inline

Construct a new MCParticle object.

~MCParticle()

virtual Herd::MCParticle::~MCParticle ( )

virtualdefault

Virtual destructor

Member Function Documentation

InitialMomentum()

Vec3D Herd::MCParticle::InitialMomentum ( ) const

inline

Get the generation momentum of the particle.

Returns

the generation Momentum.

InitialPosition()

Point Herd::MCParticle::InitialPosition ( ) const

inline

Get the generation position of the particle.

Returns

the generation Point.

InitialTime()

float Herd::MCParticle::InitialTime ( ) const

inline

Get the time of generation of the particle.

Returns

the generation time.

InitialTrajectory()

Line Herd::MCParticle::InitialTrajectory ( ) const

inline

Get the generation trajectory of the particle.

Returns

the generation trajectory.

PDGCode()

int Herd::MCParticle::PDGCode ( ) const

inline

Get the PDG code of the particle.

Returns

the PDG code.

Member Data Documentation

m_initialMomentum

Vec3D Herd::MCParticle::m_initialMomentum

private

Initial momentum vector.

m_initialPosition

Point Herd::MCParticle::m_initialPosition

private

Initial position vector.

m_initialTime

float Herd::MCParticle::m_initialTime

private

Generation time of the particle in the MC simulation [ns].

m_pdgCode

int Herd::MCParticle::m_pdgCode

private

PDG code of the particle.

---

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

• /builds/herd/HerdSoftware/include/herd/analysis/dataobjects/MCParticle.h