GeneratedParticleInfo.h

Go to the documentation of this file.

#ifndef LARDATAOBJ_SIMULATION_GENERATEDPARTICLEINFO_H
#define LARDATAOBJ_SIMULATION_GENERATEDPARTICLEINFO_H

// LArSoft libraries
#include "nusimdata/SimulationBase/simb.h" // sim::GeneratedParticleIndex_t, ...


namespace sim {
  
  class GeneratedParticleInfo {
    
      public:
    
    //--- BEGIN Generated particle index ---------------------------------------
    
    using GeneratedParticleIndex_t = simb::GeneratedParticleIndex_t;
    
    static constexpr GeneratedParticleIndex_t NoGeneratedParticleIndex
      = simb::NoGeneratedParticleIndex;
    
    GeneratedParticleIndex_t generatedParticleIndex() const
      { return fGeneratedParticleIndex; }
    
    bool hasGeneratedParticleIndex() const
      { return simb::isGeneratedParticleIndex(fGeneratedParticleIndex); }
    
    //--- END Generated particle index -----------------------------------------
    
    
    //--- BEGIN Constructors ---------------------------------------------------
    GeneratedParticleInfo() = default;
    
    GeneratedParticleInfo(GeneratedParticleIndex_t index)
      : fGeneratedParticleIndex(index)
      {}
    //--- END Constructors ---------------------------------------------------
    
    
      private:
    
    GeneratedParticleIndex_t fGeneratedParticleIndex = NoGeneratedParticleIndex;
    
  }; // class GeneratedParticleInfo
  
  
  
} // namespace sim

#endif // LARDATAOBJ_SIMULATION_GENERATEDPARTICLEINFO_H