larg4::ParticleListAction::ParticleInfo_t Struct Reference

#include "ParticleListAction.h"

Public Member Functions
void	clear ()
	Resets the information (does not release memory it does not own) More...
bool	hasParticle () const
	Returns whether there is a particle. More...
bool	isPrimary () const
	Returns whether there is a particle. More...
bool	keepParticle () const
	Returns whether there is a particle known to be kept. More...
GeneratedParticleIndex_t	truthInfoIndex () const
	Returns the index of the particle in the generator truth record. More...

Public Attributes
cet::exempt_ptr< simb::MCParticle >	particle
	Object representing particle. More...
bool	keep = false
	if there was decision to keep More...
bool	drop
GeneratedParticleIndex_t	truthIndex = simb::NoGeneratedParticleIndex
	Index of the particle in the original generator truth record. More...

Detailed Description

Definition at line 49 of file ParticleListAction.h.

Member Function Documentation

void larg4::ParticleListAction::ParticleInfo_t::clear ( )

inline

Resets the information (does not release memory it does not own)

Definition at line 59 of file ParticleListAction.h.

References simb::NoGeneratedParticleIndex.

Referenced by larg4::ParticleListAction::BeginOfEventAction(), larg4::ParticleListAction::PostTrackingAction(), and larg4::ParticleListAction::PreTrackingAction().

      {
        particle = nullptr;
        keep = false;
        drop = false;
        truthIndex = simb::NoGeneratedParticleIndex;
      }

bool larg4::ParticleListAction::ParticleInfo_t::hasParticle ( ) const

inline

Returns whether there is a particle.

Definition at line 68 of file ParticleListAction.h.

Referenced by larg4::ParticleListAction::PostTrackingAction(), and larg4::ParticleListAction::SteppingAction().

{ return !particle.empty(); }

bool larg4::ParticleListAction::ParticleInfo_t::isPrimary ( ) const

inline

Returns whether there is a particle.

Definition at line 71 of file ParticleListAction.h.

References simb::isGeneratedParticleIndex().

Referenced by larg4::ParticleListAction::PostTrackingAction().

{ return simb::isGeneratedParticleIndex(truthIndex); }

bool larg4::ParticleListAction::ParticleInfo_t::keepParticle ( ) const

inline

Returns whether there is a particle known to be kept.

Definition at line 74 of file ParticleListAction.h.

{ return hasParticle() && keep; }

GeneratedParticleIndex_t larg4::ParticleListAction::ParticleInfo_t::truthInfoIndex ( ) const

inline

Returns the index of the particle in the generator truth record.

Definition at line 77 of file ParticleListAction.h.

Referenced by larg4::ParticleListAction::PostTrackingAction().

{ return truthIndex; }

Member Data Documentation

bool larg4::ParticleListAction::ParticleInfo_t::drop

Initial value:

=
        false

For EM shower daughters, whether to drop them (independently of keep)

Definition at line 53 of file ParticleListAction.h.

Referenced by larg4::ParticleListAction::PostTrackingAction(), and larg4::ParticleListAction::PreTrackingAction().

bool larg4::ParticleListAction::ParticleInfo_t::keep = false

if there was decision to keep

Definition at line 52 of file ParticleListAction.h.

Referenced by larg4::ParticleListAction::AddPointToCurrentParticle(), larg4::ParticleListAction::PostTrackingAction(), and larg4::ParticleListAction::PreTrackingAction().

cet::exempt_ptr<simb::MCParticle> larg4::ParticleListAction::ParticleInfo_t::particle

Object representing particle.

Definition at line 51 of file ParticleListAction.h.

Referenced by larg4::ParticleListAction::AddPointToCurrentParticle(), larg4::ParticleListAction::PostTrackingAction(), larg4::ParticleListAction::PreTrackingAction(), and larg4::ParticleListAction::SteppingAction().

GeneratedParticleIndex_t larg4::ParticleListAction::ParticleInfo_t::truthIndex = simb::NoGeneratedParticleIndex

Index of the particle in the original generator truth record.

Definition at line 56 of file ParticleListAction.h.

Referenced by larg4::ParticleListAction::PreTrackingAction().

---

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

• larsim/v09_43_00/source/larsim/LegacyLArG4/ParticleListAction.h