art::ModuleBase Class Reference

#include "ModuleBase.h"

Inheritance diagram for art::ModuleBase:

Public Member Functions
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
virtual std::unique_ptr< Worker >	doMakeWorker (WorkerParams const &wp)=0

Private Attributes
std::optional< ModuleDescription >	md_ {std::nullopt}
ConsumesCollector	collector_

Detailed Description

Definition at line 20 of file ModuleBase.h.

Constructor & Destructor Documentation

art::ModuleBase::~ModuleBase ( )

virtualdefaultnoexcept

art::ModuleBase::ModuleBase ( )

default

Member Function Documentation

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const &  tag )

protected

Definition at line 61 of file ModuleBase.h.

References collector_, and art::ConsumesCollector::consumes().

  {
    return collector_.consumes<T, BT>(tag);
  }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protected

Definition at line 57 of file ModuleBase.cc.

References collector_.

  {
    return collector_;
  }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protected

Definition at line 75 of file ModuleBase.h.

References collector_, and art::ConsumesCollector::consumesMany().

  {
    collector_.consumesMany<T, BT>();
  }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const &  )

protected

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView

(

InputTag const &

tag

)

Definition at line 68 of file ModuleBase.h.

References collector_, and art::ConsumesCollector::consumesView().

  {
    return collector_.consumesView<T, BT>(tag);
  }

virtual std::unique_ptr<Worker> art::ModuleBase::doMakeWorker ( WorkerParams const &  wp )

privatepure virtual

Implemented in art::OutputModule, art::ResultsProducer, art::ReplicatedAnalyzer, art::EDAnalyzer, art::ReplicatedProducer, art::ReplicatedFilter, art::EDFilter, art::EDProducer, art::SharedAnalyzer, art::SharedProducer, and art::SharedFilter.

Referenced by makeWorker().

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables

(

)

const

Definition at line 43 of file ModuleBase.cc.

References collector_, and art::ConsumesCollector::getConsumables().

  {
    return collector_.getConsumables();
  }

std::unique_ptr< Worker > art::ModuleBase::makeWorker

(

WorkerParams const &

wp

)

Definition at line 37 of file ModuleBase.cc.

References doMakeWorker(), and art::NumBranchTypes.

  {
    return doMakeWorker(wp);
  }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const &  tag )

protected

Definition at line 82 of file ModuleBase.h.

References collector_, and art::ConsumesCollector::mayConsume().

  {
    return collector_.mayConsume<T, BT>(tag);
  }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protected

Definition at line 96 of file ModuleBase.h.

References collector_, and art::ConsumesCollector::mayConsumeMany().

  {
    collector_.mayConsumeMany<T, BT>();
  }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const &  )

protected

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView

(

InputTag const &

tag

)

Definition at line 89 of file ModuleBase.h.

References collector_, and art::ConsumesCollector::mayConsumeView().

  {
    return collector_.mayConsumeView<T, BT>(tag);
  }

ModuleDescription const & art::ModuleBase::moduleDescription

(

)

const

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

  {
    if (md_.has_value()) {
      return *md_;
    }

    throw Exception{errors::LogicError,
                    "There was an error while calling moduleDescription().\n"}
      << "The moduleDescription() base-class member function cannot be called\n"
         "during module construction.  To determine which module is "
         "responsible\n"
         "for calling it, find the '<module type>:<module "
         "label>@Construction'\n"
         "tag in the message prefix above.  Please contact artists@fnal.gov\n"
         "for guidance.\n";
  }

void art::ModuleBase::setModuleDescription

(

ModuleDescription const &

md

)

Definition at line 31 of file ModuleBase.cc.

References md_.

  {
    md_ = md;
  }

void art::ModuleBase::sortConsumables

(

std::string const &

current_process_name

)

Definition at line 49 of file ModuleBase.cc.

References collector_, and art::ConsumesCollector::sortConsumables().

  {
    // Now that we know we have seen all the consumes declarations,
    // sort the results for fast lookup later.
    collector_.sortConsumables(current_process_name);
  }

Member Data Documentation

ConsumesCollector art::ModuleBase::collector_

private

Definition at line 56 of file ModuleBase.h.

Referenced by consumes(), consumesCollector(), consumesMany(), consumesView(), getConsumables(), mayConsume(), mayConsumeMany(), mayConsumeView(), and sortConsumables().

std::optional<ModuleDescription> art::ModuleBase::md_ {std::nullopt}

private

Definition at line 55 of file ModuleBase.h.

Referenced by setModuleDescription().

---

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

• art/Framework/Core/ModuleBase.h
• art/Framework/Core/ModuleBase.cc