Description of a Monte Carlo primary particle. More...

#include <dataobjects/MCPrimaryParticle.h>

Inheritance diagram for Herd::MCPrimaryParticle:

Public Member Functions
	MCPrimaryParticle ()
	Default constructor. More...

	MCPrimaryParticle (Point position, Momentum momentum)
	Construct a new MCPrimaryParticle object. More...

	MCPrimaryParticle (float initialTime, int pdgCode, Point position, Momentum momentum)
	Construct a new MCPrimaryParticle object. More...

	~MCPrimaryParticle () override=default
	Virtual destructor More...

bool	HadronicInelasticInteractionIsPresent () const
	Return true if the first hadronic interaction is present. More...

const MCInteraction &	HadronicInelasticInteraction () const
	Return the first hadronic interaction. More...

void	SetHadronicInelasticInteraction (MCInteraction interaction)
	Set the first hadronic object. More...

void	SetNoHadronicInelasticInteraction ()
	Indicate that the first hadronic interaction is not found. More...

bool	PrimaryDisappearanceIsPresent () const
	Return true if the primary disappearance is present. More...

const MCInteraction &	PrimaryDisappearance () const
	Return the primary disappearance. More...

void	SetPrimaryDisappearance (MCInteraction interaction)
	Set the first hadronic object. More...

void	SetNoPrimaryDisappearance ()
	Indicate that the primary disappearance is not found. More...

bool	HadronicQuasiElasticInteractionIsPresent () const
	Return true if hadronic quasi-elastic interactions are present. More...

const std::vector< MCInteraction > &	HadronicQuasiElasticInteractions () const
	Return a list of hadronic quasi-elastic interaction. More...

void	AddHadronicQuasiElasticInteraction (MCInteraction interaction)
	Set the first hadronic object. More...

void	SetNHadronicQuasiElasticInteractions (size_t nInteractions)
	Indicate that the first hadronic interaction is not found. More...

Public Member Functions inherited from Herd::MCParticle
	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
std::vector< MCInteraction >	m_hadronicInelasticInteraction
	First hadronic inelastic interaction of the particle. More...

std::vector< MCInteraction >	m_hadronicQuasiElasticInteractions
	Vector with hadronic quasi-elastic interactions of the particle. More...

std::vector< MCInteraction >	m_primaryDisappearence
	Primary disappearence event. More...

Detailed Description

Description of a Monte Carlo primary particle.

Constructor & Destructor Documentation

◆ MCPrimaryParticle() [1/3]

Herd::MCPrimaryParticle::MCPrimaryParticle ( )

inline

Default constructor.

◆ MCPrimaryParticle() [2/3]

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

inline

Construct a new MCPrimaryParticle object.

◆ MCPrimaryParticle() [3/3]

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

inline

Construct a new MCPrimaryParticle object.

◆ ~MCPrimaryParticle()

Herd::MCPrimaryParticle::~MCPrimaryParticle ( )

overridedefault

Virtual destructor

Member Function Documentation

◆ AddHadronicQuasiElasticInteraction()

void Herd::MCPrimaryParticle::AddHadronicQuasiElasticInteraction ( MCInteraction interaction )

Set the first hadronic object.

Parameters

interaction the first hadronic interaction.

◆ HadronicInelasticInteraction()

const MCInteraction & Herd::MCPrimaryParticle::HadronicInelasticInteraction ( ) const

Return the first hadronic interaction.

If the hadronic interaction information is not available a std::logic_error is thrown. Please check HadronicInelasticInteractionIsPresent before using this function.

Returns: MCInteraction First hadronic interaction information.

◆ HadronicInelasticInteractionIsPresent()

bool Herd::MCPrimaryParticle::HadronicInelasticInteractionIsPresent ( ) const

Return true if the first hadronic interaction is present.

Returns: true if the first hadronic interaction is present, false otherwise.

◆ HadronicQuasiElasticInteractionIsPresent()

bool Herd::MCPrimaryParticle::HadronicQuasiElasticInteractionIsPresent ( ) const

Return true if hadronic quasi-elastic interactions are present.

Returns: true if hadronic quasi-elastic interactions are present, false otherwise.

◆ HadronicQuasiElasticInteractions()

const std::vector< MCInteraction > & Herd::MCPrimaryParticle::HadronicQuasiElasticInteractions ( ) const

Return a list of hadronic quasi-elastic interaction.

If the hadronic interaction information is not available a std::logic_error is thrown. Please check HadronicQuasiElasticInteractionIsPresent before using this function.

Returns: vector of MCInteraction hadronic quasi-elastic interactions information.

◆ PrimaryDisappearance()

const MCInteraction & Herd::MCPrimaryParticle::PrimaryDisappearance ( ) const

Return the primary disappearance.

If the primary disappearance information is not available a std::logic_error is thrown. Please check PrimaryDisappearanceIsPresent before using this function.

Returns: MCInteraction primary disappearance information.

◆ PrimaryDisappearanceIsPresent()

bool Herd::MCPrimaryParticle::PrimaryDisappearanceIsPresent ( ) const

Return true if the primary disappearance is present.

Returns: true if the primary disappearance is present, false otherwise.

◆ SetHadronicInelasticInteraction()

void Herd::MCPrimaryParticle::SetHadronicInelasticInteraction ( MCInteraction interaction )

Set the first hadronic object.

Parameters

interaction the first hadronic interaction.

◆ SetNHadronicQuasiElasticInteractions()

void Herd::MCPrimaryParticle::SetNHadronicQuasiElasticInteractions ( size_t nInteractions )

Indicate that the first hadronic interaction is not found.

◆ SetNoHadronicInelasticInteraction()

void Herd::MCPrimaryParticle::SetNoHadronicInelasticInteraction ( )

Indicate that the first hadronic interaction is not found.

◆ SetNoPrimaryDisappearance()

void Herd::MCPrimaryParticle::SetNoPrimaryDisappearance ( )

Indicate that the primary disappearance is not found.

◆ SetPrimaryDisappearance()

void Herd::MCPrimaryParticle::SetPrimaryDisappearance ( MCInteraction interaction )

Set the first hadronic object.

Parameters

interaction the primary disappearance.

Member Data Documentation

◆ m_hadronicInelasticInteraction

std::vector<MCInteraction> Herd::MCPrimaryParticle::m_hadronicInelasticInteraction

private

First hadronic inelastic interaction of the particle.

◆ m_hadronicQuasiElasticInteractions

std::vector<MCInteraction> Herd::MCPrimaryParticle::m_hadronicQuasiElasticInteractions

private

Vector with hadronic quasi-elastic interactions of the particle.

◆ m_primaryDisappearence

std::vector<MCInteraction> Herd::MCPrimaryParticle::m_primaryDisappearence

private

Primary disappearence event.

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

/builds/herd/HerdSoftware/include/herd/analysis/dataobjects/MCPrimaryParticle.h
/builds/herd/HerdSoftware/src/analysis/dataobjects/MCPrimaryParticle.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MCPrimaryParticle() [1/3]

◆ MCPrimaryParticle() [2/3]

◆ MCPrimaryParticle() [3/3]

◆ ~MCPrimaryParticle()

Member Function Documentation

◆ AddHadronicQuasiElasticInteraction()

◆ HadronicInelasticInteraction()

◆ HadronicInelasticInteractionIsPresent()

◆ HadronicQuasiElasticInteractionIsPresent()

◆ HadronicQuasiElasticInteractions()

◆ PrimaryDisappearance()

◆ PrimaryDisappearanceIsPresent()

◆ SetHadronicInelasticInteraction()

◆ SetNHadronicQuasiElasticInteractions()

◆ SetNoHadronicInelasticInteraction()

◆ SetNoPrimaryDisappearance()

◆ SetPrimaryDisappearance()

Member Data Documentation

◆ m_hadronicInelasticInteraction

◆ m_hadronicQuasiElasticInteractions

◆ m_primaryDisappearence