art::Consumer Class Reference

#include "Consumer.h"

Inheritance diagram for art::Consumer:

Classes
struct	InvalidTag

Public Member Functions
	Consumer ()=default
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)
template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)
template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)
template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	setModuleDescription (ModuleDescription const &md)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

Private Types
using	ConsumableType = ProductInfo::ConsumableType

Private Member Functions
	Consumer (InvalidTag)

Private Attributes
bool	moduleContext_ {true}
bool	requireConsumes_ {false}
ConsumableProducts	consumables_ {}
ConsumableProductSets	missingConsumes_ {}
cet::exempt_ptr< ModuleDescription const >	moduleDescription_ {nullptr}

Friends
class	DataViewImpl

Detailed Description

Definition at line 87 of file Consumer.h.

Member Typedef Documentation

using art::Consumer::ConsumableType = ProductInfo::ConsumableType

private

Definition at line 133 of file Consumer.h.

Constructor & Destructor Documentation

art::Consumer::Consumer ( )

explicitdefault

art::Consumer::Consumer ( InvalidTag  )

inlineexplicitprivate

Definition at line 134 of file Consumer.h.

: moduleContext_{false} {}

Member Function Documentation

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes

(

InputTag const &

)

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes

(

InputTag const &

it

)

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany

(

)

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView

(

InputTag const &

)

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView

(

InputTag const &

it

)

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume

(

InputTag const &

)

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume

(

InputTag const &

it

)

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany

(

)

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView

(

InputTag const &

)

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView

(

InputTag const &

it

)

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

static

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset )

protected

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

void art::Consumer::setModuleDescription ( ModuleDescription const &  md )

protected

Definition at line 83 of file Consumer.cc.

Referenced by art::ResultsProducer::doBeginJob(), art::EDProducer::setModuleDescription(), art::EDFilter::setModuleDescription(), and art::EDAnalyzer::setModuleDescription().

{
  moduleDescription_ = &md;
}

void art::Consumer::showMissingConsumes ( ) const

protected

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protected

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

Friends And Related Function Documentation

friend class DataViewImpl

friend

Definition at line 118 of file Consumer.h.

Member Data Documentation

ConsumableProducts art::Consumer::consumables_ {}

private

Definition at line 138 of file Consumer.h.

ConsumableProductSets art::Consumer::missingConsumes_ {}

private

Definition at line 139 of file Consumer.h.

bool art::Consumer::moduleContext_ {true}

private

Definition at line 136 of file Consumer.h.

cet::exempt_ptr<ModuleDescription const> art::Consumer::moduleDescription_ {nullptr}

private

Definition at line 140 of file Consumer.h.

bool art::Consumer::requireConsumes_ {false}

private

Definition at line 137 of file Consumer.h.

---

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

• art/Framework/Principal/Consumer.h
• art/Framework/Principal/Consumer.cc