LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_content::LArMCParticle Class Reference

LAr mc particle class. More...

#include "LArMCParticle.h"

Inheritance diagram for lar_content::LArMCParticle:

Public Member Functions

 LArMCParticle (const LArMCParticleParameters &parameters)
 Constructor. More...
 
int GetNuanceCode () const
 Get the nuance code. More...
 
void FillParameters (LArMCParticleParameters &parameters) const
 Fill the parameters associated with this MC particle. More...
 
MCProcess GetProcess () const
 Get the process. More...
 

Private Attributes

int m_nuanceCode
 The nuance code. More...
 
int m_process
 The process that created the particle. More...
 

Detailed Description

LAr mc particle class.

Definition at line 94 of file LArMCParticle.h.

Constructor & Destructor Documentation

lar_content::LArMCParticle::LArMCParticle ( const LArMCParticleParameters parameters)
inline

Constructor.

Parameters
parametersthe lar mc particle parameters

Definition at line 183 of file LArMCParticle.h.

183  :
184  object_creation::MCParticle::Object(parameters),
185  m_nuanceCode(parameters.m_nuanceCode.Get()),
186  m_process(parameters.m_process.Get())
187 {
188 }
int m_process
The process that created the particle.
int m_nuanceCode
The nuance code.

Member Function Documentation

void lar_content::LArMCParticle::FillParameters ( LArMCParticleParameters parameters) const
inline

Fill the parameters associated with this MC particle.

Parameters
parametersthe output parameters

Definition at line 199 of file LArMCParticle.h.

References GetNuanceCode(), GetProcess(), lar_content::LArMCParticleParameters::m_nuanceCode, and lar_content::LArMCParticleParameters::m_process.

Referenced by lar_content::MasterAlgorithm::Reset().

200 {
201  parameters.m_nuanceCode = this->GetNuanceCode();
202  parameters.m_process = this->GetProcess();
203  parameters.m_energy = this->GetEnergy();
204  parameters.m_momentum = this->GetMomentum();
205  parameters.m_vertex = this->GetVertex();
206  parameters.m_endpoint = this->GetEndpoint();
207  parameters.m_particleId = this->GetParticleId();
208  parameters.m_mcParticleType = this->GetMCParticleType();
209  // ATTN Set the parent address to the original owner of the mc particle
210  parameters.m_pParentAddress = static_cast<const void *>(this);
211 }
int GetNuanceCode() const
Get the nuance code.
MCProcess GetProcess() const
Get the process.
int lar_content::LArMCParticle::GetNuanceCode ( ) const
inline

Get the nuance code.

Returns
the nuance code

Definition at line 192 of file LArMCParticle.h.

References m_nuanceCode.

Referenced by FillParameters(), lar_content::LArMCParticleHelper::GetNuanceCode(), lar_content::EventWritingAlgorithm::PassNuanceCodeFilter(), and lar_content::LArMCParticleFactory::Write().

193 {
194  return m_nuanceCode;
195 }
int m_nuanceCode
The nuance code.
MCProcess lar_content::LArMCParticle::GetProcess ( ) const
inline

Get the process.

Returns
the process

Definition at line 215 of file LArMCParticle.h.

References m_process.

Referenced by FillParameters(), lar_content::LArMuonLeadingHelper::GetLeadingProcess(), lar_content::HierarchyMonitoringAlgorithm::Run(), and lar_content::LArMCParticleFactory::Write().

216 {
217  return MCProcess(m_process);
218 }
int m_process
The process that created the particle.

Member Data Documentation

int lar_content::LArMCParticle::m_nuanceCode
private

The nuance code.

Definition at line 126 of file LArMCParticle.h.

Referenced by GetNuanceCode().

int lar_content::LArMCParticle::m_process
private

The process that created the particle.

Definition at line 127 of file LArMCParticle.h.

Referenced by GetProcess().


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