Public Member Functions | Public Attributes | List of all members
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
 Rerturns 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::MCParticleparticle
 Object representing particle. More...
 
bool keep = false
 
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 58 of file ParticleListAction.h.

59  {
60  particle = nullptr;
61  keep = false;
63  }
GeneratedParticleIndex_t truthIndex
Index of the particle in the original generator truth record.
constexpr GeneratedParticleIndex_t NoGeneratedParticleIndex
Constant representing the absence of generator truth information.
Definition: simb.h:34
cet::exempt_ptr< simb::MCParticle > particle
Object representing particle.
bool larg4::ParticleListAction::ParticleInfo_t::hasParticle ( ) const
inline

Returns whether there is a particle.

Definition at line 67 of file ParticleListAction.h.

68  {
69  return !particle.empty();
70  }
constexpr bool empty() const noexcept
Definition: exempt_ptr.h:153
cet::exempt_ptr< simb::MCParticle > particle
Object representing particle.
bool larg4::ParticleListAction::ParticleInfo_t::isPrimary ( ) const
inline

Returns whether there is a particle.

Definition at line 74 of file ParticleListAction.h.

75  {
77  }
GeneratedParticleIndex_t truthIndex
Index of the particle in the original generator truth record.
bool isGeneratedParticleIndex(GeneratedParticleIndex_t index)
Returns whether the specified one is an acceptable generator index.
Definition: simb.h:37
bool larg4::ParticleListAction::ParticleInfo_t::keepParticle ( ) const
inline

Rerturns whether there is a particle known to be kept.

Definition at line 81 of file ParticleListAction.h.

82  {
83  return hasParticle() && keep;
84  }
bool hasParticle() const
Returns whether there is a particle.
GeneratedParticleIndex_t larg4::ParticleListAction::ParticleInfo_t::truthInfoIndex ( ) const
inline

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

Definition at line 88 of file ParticleListAction.h.

89  {
90  return truthIndex;
91  }
GeneratedParticleIndex_t truthIndex
Index of the particle in the original generator truth record.

Member Data Documentation

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

if there was decision to keep

Definition at line 52 of file ParticleListAction.h.

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

Object representing particle.

Definition at line 51 of file ParticleListAction.h.

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

Index of the particle in the original generator truth record.

Definition at line 54 of file ParticleListAction.h.


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