All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
icarus::trigger::details::EventInfoExtractorMaker Class Reference

A helper class creating a EventInfoExtractor with a specific setup. More...

#include <EventInfoUtils.h>

Public Types

using TimeSpan_t = EventInfoExtractor::TimeSpan_t
 
using EDepTags_t = EventInfoExtractor::EDepTags_t
 

Public Member Functions

 EventInfoExtractorMaker (std::vector< art::InputTag > truthTags, EDepTags_t edepTags, geo::GeometryCore const &geom, detinfo::DetectorPropertiesData const *detProps, detinfo::DetectorTimings const *detTimings, std::string logCategory)
 Constructor: stores parameters for construction of EventInfoExtractor. More...
 
template<typename ConsumesColl >
 EventInfoExtractorMaker (std::vector< art::InputTag > truthTags, EDepTags_t edepTags, geo::GeometryCore const &geom, detinfo::DetectorPropertiesData const *detProps, detinfo::DetectorTimings const *detTimings, std::string logCategory, ConsumesColl &consumesCollector)
 
bool hasGenerated () const
 Returns whether we are extracting any generator information. More...
 
bool hasEDep () const
 Returns whether we are extracting any energy deposition information. More...
 
EventInfoExtractor make (TimeSpan_t inSpillTimes, TimeSpan_t inPreSpillTimes) const
 Creates and returns a new EventInfoExtractor object. More...
 
EventInfoExtractor operator() (TimeSpan_t inSpillTimes, TimeSpan_t inPreSpillTimes) const
 

Private Attributes

std::vector< art::InputTag > const fGeneratorTags
 
EDepTags_t fEnergyDepositTags
 
std::string const fLogCategory
 
geo::GeometryCore const & fGeom
 
detinfo::DetectorPropertiesData
const * 
fDetProps = nullptr
 
detinfo::DetectorTimings const * fDetTimings = nullptr
 

Detailed Description

A helper class creating a EventInfoExtractor with a specific setup.

Definition at line 367 of file EventInfoUtils.h.

Member Typedef Documentation

Definition at line 372 of file EventInfoUtils.h.

Definition at line 371 of file EventInfoUtils.h.

Constructor & Destructor Documentation

icarus::trigger::details::EventInfoExtractorMaker::EventInfoExtractorMaker ( std::vector< art::InputTag >  truthTags,
EDepTags_t  edepTags,
geo::GeometryCore const &  geom,
detinfo::DetectorPropertiesData const *  detProps,
detinfo::DetectorTimings const *  detTimings,
std::string  logCategory 
)

Constructor: stores parameters for construction of EventInfoExtractor.

Definition at line 356 of file EventInfoUtils.cxx.

364  : fGeneratorTags(std::move(truthTags))
365  , fEnergyDepositTags(std::move(edepTags))
366  , fLogCategory(std::move(logCategory))
367  , fGeom(geom)
370  {}
fDetProps &fDetProps detProps
std::vector< art::InputTag > const fGeneratorTags
detinfo::DetectorTimings const * fDetTimings
detinfo::DetectorPropertiesData const * fDetProps
fDetProps &fDetProps fDetProps &fDetProps detTimings
template<typename ConsumesColl >
icarus::trigger::details::EventInfoExtractorMaker::EventInfoExtractorMaker ( std::vector< art::InputTag >  truthTags,
EDepTags_t  edepTags,
geo::GeometryCore const &  geom,
detinfo::DetectorPropertiesData const *  detProps,
detinfo::DetectorTimings const *  detTimings,
std::string  logCategory,
ConsumesColl &  consumesCollector 
)

Constructor: stores parameters for construction of EventInfoExtractor and declares consumables.

Definition at line 607 of file EventInfoUtils.h.

617  std::move(truthTags), std::move(edepTags),
618  geom, detProps, detTimings, std::move(logCategory)
619  )
620 {
623 } // icarus::trigger::details::EventInfoExtractorMaker::EventInfoExtractorMaker()
fDetProps &fDetProps detProps
std::vector< art::InputTag > const fGeneratorTags
static void declareConsumables(ConsumesColl &consumesCollector, std::vector< art::InputTag > const &truthTags, EDepTags_t const &edepTags)
Declares all the consumables to the collector.
EventInfoExtractorMaker(std::vector< art::InputTag > truthTags, EDepTags_t edepTags, geo::GeometryCore const &geom, detinfo::DetectorPropertiesData const *detProps, detinfo::DetectorTimings const *detTimings, std::string logCategory)
Constructor: stores parameters for construction of EventInfoExtractor.
fDetProps &fDetProps fDetProps &fDetProps detTimings
fDetProps &fDetProps fDetProps &fDetProps consumesCollector())

Member Function Documentation

bool icarus::trigger::details::EventInfoExtractorMaker::hasEDep ( ) const
inline

Returns whether we are extracting any energy deposition information.

Definition at line 413 of file EventInfoUtils.h.

static bool isEDepSpecified(EDepTags_t const &edepTag)
Returns whether edepTags contains any energy deposition tag.
bool icarus::trigger::details::EventInfoExtractorMaker::hasGenerated ( ) const
inline

Returns whether we are extracting any generator information.

Definition at line 410 of file EventInfoUtils.h.

410 { return !fGeneratorTags.empty(); }
std::vector< art::InputTag > const fGeneratorTags
icarus::trigger::details::EventInfoExtractor icarus::trigger::details::EventInfoExtractorMaker::make ( TimeSpan_t  inSpillTimes,
TimeSpan_t  inPreSpillTimes 
) const

Creates and returns a new EventInfoExtractor object.

Definition at line 376 of file EventInfoUtils.cxx.

377 {
378  return EventInfoExtractor{
380  inSpillTimes, inPreSpillTimes,
382  };
383 } // icarus::trigger::details::EventInfoExtractorMaker::make()
std::vector< art::InputTag > const fGeneratorTags
detinfo::DetectorTimings const * fDetTimings
detinfo::DetectorPropertiesData const * fDetProps
EventInfoExtractor icarus::trigger::details::EventInfoExtractorMaker::operator() ( TimeSpan_t  inSpillTimes,
TimeSpan_t  inPreSpillTimes 
) const
inline

Definition at line 404 of file EventInfoUtils.h.

405  { return make(inSpillTimes, inPreSpillTimes); }
EventInfoExtractor make(TimeSpan_t inSpillTimes, TimeSpan_t inPreSpillTimes) const
Creates and returns a new EventInfoExtractor object.

Member Data Documentation

detinfo::DetectorPropertiesData const* icarus::trigger::details::EventInfoExtractorMaker::fDetProps = nullptr
private

Definition at line 423 of file EventInfoUtils.h.

detinfo::DetectorTimings const* icarus::trigger::details::EventInfoExtractorMaker::fDetTimings = nullptr
private

Definition at line 424 of file EventInfoUtils.h.

EDepTags_t icarus::trigger::details::EventInfoExtractorMaker::fEnergyDepositTags
private

Definition at line 420 of file EventInfoUtils.h.

std::vector<art::InputTag> const icarus::trigger::details::EventInfoExtractorMaker::fGeneratorTags
private

Definition at line 419 of file EventInfoUtils.h.

geo::GeometryCore const& icarus::trigger::details::EventInfoExtractorMaker::fGeom
private

Definition at line 422 of file EventInfoUtils.h.

std::string const icarus::trigger::details::EventInfoExtractorMaker::fLogCategory
private

Definition at line 421 of file EventInfoUtils.h.


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