art::ConsumesInfo Class Reference

#include "ConsumesInfo.h"

Public Types
using	consumables_t = std::map< std::string const, std::array< std::vector< ProductInfo >, NumBranchTypes >>

Public Member Functions
	~ConsumesInfo ()
	ConsumesInfo (ConsumesInfo const &)=delete
	ConsumesInfo (ConsumesInfo &&)=delete
ConsumesInfo &	operator= (ConsumesInfo const &)=delete
ConsumesInfo &	operator= (ConsumesInfo &&)=delete
void	setRequireConsumes (bool const)
consumables_t::mapped_type const &	consumables (std::string const &module_label) const
void	collectConsumes (std::string const &module_label, consumables_t::mapped_type const &consumables)
void	validateConsumedProduct (BranchType const, ModuleDescription const &, ProductInfo const &productInfo)
void	showMissingConsumes () const

Static Public Member Functions
static ConsumesInfo *	instance ()
static std::string	assemble_consumes_statement (BranchType const, ProductInfo const &)
static std::string	module_context (ModuleDescription const &)

Private Member Functions
	ConsumesInfo ()

Private Attributes
std::recursive_mutex	mutex_ {}
std::atomic< bool >	requireConsumes_
consumables_t	consumables_
std::map< std::string const, std::array< std::set< ProductInfo >, NumBranchTypes > >	missingConsumes_

Detailed Description

Definition at line 88 of file ConsumesInfo.h.

Member Typedef Documentation

using art::ConsumesInfo::consumables_t = std::map<std::string const, std::array<std::vector<ProductInfo>, NumBranchTypes>>

Definition at line 107 of file ConsumesInfo.h.

Constructor & Destructor Documentation

art::ConsumesInfo::~ConsumesInfo ( )

default

art::ConsumesInfo::ConsumesInfo ( ConsumesInfo const &  )

delete

art::ConsumesInfo::ConsumesInfo ( ConsumesInfo &&  )

delete

art::ConsumesInfo::ConsumesInfo ( )

private

Definition at line 21 of file ConsumesInfo.cc.

Referenced by consumables().

  {
    requireConsumes_ = false;
  }

Member Function Documentation

string art::ConsumesInfo::assemble_consumes_statement ( BranchType const  bt, ProductInfo const &  pi  )

static

Definition at line 34 of file ConsumesInfo.cc.

References art::BranchTypeToString(), and art::InEvent.

  {
    string result;
    // Create "consumes" prefix
    switch (pi.consumableType) {
    case ProductInfo::ConsumableType::Product:
      result += "consumes";
      break;
    case ProductInfo::ConsumableType::ViewElement:
      result += "consumesView";
      break;
    case ProductInfo::ConsumableType::Many:
      result += "consumesMany";
      break;
    }
    // .. now time for the template arguments
    result += '<';
    result += pi.typeID.className();
    if (bt != InEvent) {
      result += ", In";
      result += BranchTypeToString(bt);
    }
    result += '>';
    // Form "(...);" string with appropriate arguments.
    result += '(';
    // Early bail out for consumesMany.
    if (pi.consumableType == ProductInfo::ConsumableType::Many) {
      result += ");";
      return result;
    }
    result += '"';
    result += pi.label;
    // If the process name is non-empty, then all InputTag fields are
    // required (e.g.):
    //   "myLabel::myProcess"
    //   "myLabel::myInstance::myProcess"
    if (!pi.process.name().empty()) {
      result += ':';
      result += pi.instance;
      result += ':';
      result += pi.process.name();
    } else if (!pi.instance.empty()) {
      result += ':';
      result += pi.instance;
    }
    result += "\");";
    return result;
  }

void art::ConsumesInfo::collectConsumes	(	std::string const &	module_label,
		consumables_t::mapped_type const &	consumables
	)

Definition at line 102 of file ConsumesInfo.cc.

Referenced by consumables(), and art::PathManager::makeModules_().

  {
    std::lock_guard sentry{mutex_};
    consumables_.emplace(module_label, consumables);
  }

consumables_t::mapped_type const& art::ConsumesInfo::consumables ( std::string const &  module_label ) const

inline

Definition at line 110 of file ConsumesInfo.h.

References collectConsumes(), consumables_, ConsumesInfo(), showMissingConsumes(), and validateConsumedProduct().

Referenced by art::PathManager::fillModuleOnlyDeps_().

    {
      return consumables_.at(module_label);
    }

ConsumesInfo * art::ConsumesInfo::instance ( )

static

Definition at line 27 of file ConsumesInfo.cc.

Referenced by art::EventProcessor::endJob(), art::EventProcessor::EventProcessor(), art::PathManager::fillModuleOnlyDeps_(), art::ProductRetriever::getByLabel_(), art::ProductRetriever::getContainerForView_(), art::ProductRetriever::getMany_(), and art::PathManager::makeModules_().

  {
    static ConsumesInfo me;
    return &me;
  }

string art::ConsumesInfo::module_context ( ModuleDescription const &  md )

static

Definition at line 85 of file ConsumesInfo.cc.

References art::ModuleDescription::moduleLabel(), and art::ModuleDescription::moduleName().

  {
    string result{"module label: '"};
    result += md.moduleLabel();
    result += "' of class type '";
    result += md.moduleName();
    result += '\'';
    return result;
  }

ConsumesInfo& art::ConsumesInfo::operator= ( ConsumesInfo const &  )

delete

ConsumesInfo& art::ConsumesInfo::operator= ( ConsumesInfo &&  )

delete

void art::ConsumesInfo::setRequireConsumes

(

bool const

val

)

Definition at line 96 of file ConsumesInfo.cc.

Referenced by art::EventProcessor::EventProcessor().

  {
    requireConsumes_ = val;
  }

void art::ConsumesInfo::showMissingConsumes

(

)

const

Definition at line 134 of file ConsumesInfo.cc.

References util::pi().

Referenced by consumables(), and art::EventProcessor::endJob().

  {
    std::lock_guard sentry{mutex_};
    for (auto const& [modLabel, arySetPI] : missingConsumes_) {
      constexpr cet::HorizontalRule rule{60};
      mf::LogPrint log{"MTdiagnostics"};
      log << '\n'
          << rule('=') << '\n'
          << "The following consumes (or mayConsume) statements are missing "
             "from\n"
          << "module label: " << modLabel << '\n'
          << rule('-') << '\n';
      size_t i = 0;
      for (auto const& setPI : arySetPI) {
        for (auto const& pi : setPI) {
          log << "  "
              << assemble_consumes_statement(static_cast<BranchType>(i), pi)
              << '\n';
        }
        ++i;
      }
      log << rule('=');
    }
  }

void art::ConsumesInfo::validateConsumedProduct	(	BranchType const	bt,
		ModuleDescription const &	md,
		ProductInfo const &	productInfo
	)

Definition at line 111 of file ConsumesInfo.cc.

References art::ModuleDescription::moduleLabel(), and art::errors::ProductRegistrationFailure.

Referenced by consumables(), art::ProductRetriever::getByLabel_(), art::ProductRetriever::getContainerForView_(), and art::ProductRetriever::getMany_().

  {

    std::lock_guard sentry{mutex_};
    if (cet::binary_search_all(consumables_[md.moduleLabel()][bt],
                               productInfo)) {
      // Found it, everything is ok.
      return;
    }
    if (requireConsumes_.load()) {
      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(md) << ":\n\n"
        << "  " << assemble_consumes_statement(bt, productInfo) << "\n\n";
    }
    missingConsumes_[md.moduleLabel()][bt].insert(productInfo);
  }

Member Data Documentation

consumables_t art::ConsumesInfo::consumables_

private

Definition at line 137 of file ConsumesInfo.h.

Referenced by consumables().

std::map<std::string const, std::array<std::set<ProductInfo>, NumBranchTypes> > art::ConsumesInfo::missingConsumes_

private

Definition at line 142 of file ConsumesInfo.h.

std::recursive_mutex art::ConsumesInfo::mutex_ {}

mutableprivate

Definition at line 129 of file ConsumesInfo.h.

std::atomic<bool> art::ConsumesInfo::requireConsumes_

private

Definition at line 131 of file ConsumesInfo.h.

---

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

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