art::MasterProductRegistry Class Reference

#include "MasterProductRegistry.h"

Public Member Functions
	MasterProductRegistry ()=default
	MasterProductRegistry (MasterProductRegistry const &)=delete
MasterProductRegistry &	operator= (MasterProductRegistry const &)=delete
void	registerProductListUpdatedCallback (ProductListUpdatedCallback cb)
void	finalizeForProcessing ()
void	addProductsFromModule (ProductDescriptions &&)
void	updateFromModule (std::unique_ptr< ProductList > &&)
void	updateFromInputFile (ProductList const &)
auto const &	productList () const
auto	size () const
void	print (std::ostream &) const
bool	productProduced (BranchType branchType) const

Private Member Functions
void	addProduct_ (BranchDescription &&)
void	updateProductLists_ (ProductList const &pl)

Private Attributes
bool	allowExplicitRegistration_ {true}
ProductList	productList_ {}
std::array< bool, NumBranchTypes >	productProduced_
std::vector< ProductListUpdatedCallback >	productListUpdatedCallbacks_ {}

Detailed Description

Definition at line 47 of file MasterProductRegistry.h.

Constructor & Destructor Documentation

art::MasterProductRegistry::MasterProductRegistry ( )

explicitdefault

art::MasterProductRegistry::MasterProductRegistry ( MasterProductRegistry const &  )

delete

Member Function Documentation

void art::MasterProductRegistry::addProduct_ ( BranchDescription &&  bdp )

private

Definition at line 73 of file MasterProductRegistry.cc.

References art::errors::Configuration, and art::errors::ProductRegistrationFailure.

Referenced by productProduced().

{
  CET_ASSERT_ONLY_ONE_THREAD();

  // The below check exists primarily to ensure that the framework
  // does not accidentally call addProduct at a time when it should
  // not.
  if (!allowExplicitRegistration_) {
    throw Exception(errors::ProductRegistrationFailure)
      << "An attempt to register the product\n"
      << bdp << "was made after the product registry was frozen.\n"
      << "Product registration can be done only in module constructors.\n";
  }

  assert(bdp.produced());

  auto it = productList_.emplace(BranchKey{bdp}, BranchDescription{});
  if (!it.second) {
    throw Exception(errors::Configuration)
      << "The process name " << bdp.processName()
      << " was previously used on these products.\n"
      << "Please modify the configuration file to use a "
      << "distinct process name.\n";
  }
  auto& productListEntry = *it.first;
  auto& pd = productListEntry.second;
  pd.swap(bdp);
  productProduced_[pd.branchType()] = true;
}

void art::MasterProductRegistry::addProductsFromModule

(

ProductDescriptions &&

descriptions

)

Definition at line 25 of file MasterProductRegistry.cc.

Referenced by art::ProductRegistryHelper::registerProducts().

{
  CET_ASSERT_ONLY_ONE_THREAD();
  for (auto&& desc : descriptions) {
    addProduct_(std::move(desc));
  }
}

void art::MasterProductRegistry::finalizeForProcessing

(

)

Definition at line 14 of file MasterProductRegistry.cc.

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

{
  CET_ASSERT_ONLY_ONE_THREAD();
  // Product registration can still happen implicitly whenever an
  // input file is opened--via calls to updateFromInputFile.
  allowExplicitRegistration_ = false;
  cet::for_all(productListUpdatedCallbacks_,
               [this](auto const& callback) { callback(productList_); });
}

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

delete

void art::MasterProductRegistry::print

(

std::ostream &

os

)

const

Definition at line 61 of file MasterProductRegistry.cc.

Referenced by art::operator<<(), and size().

{
  // TODO: Shouldn't we print the BranchKey too?
  for (auto const& val : productList_) {
    os << val.second << "\n-----\n";
  }
}

auto const& art::MasterProductRegistry::productList ( ) const

inline

Definition at line 62 of file MasterProductRegistry.h.

References productList_.

  {
    return productList_;
  }

bool art::MasterProductRegistry::productProduced ( BranchType  branchType ) const

inline

Definition at line 75 of file MasterProductRegistry.h.

References addProduct_(), productProduced_, and updateProductLists_().

  {
    return productProduced_[branchType];
  }

void art::MasterProductRegistry::registerProductListUpdatedCallback

(

ProductListUpdatedCallback

cb

)

Definition at line 53 of file MasterProductRegistry.cc.

{
  CET_ASSERT_ONLY_ONE_THREAD();
  productListUpdatedCallbacks_.push_back(cb);
}

auto art::MasterProductRegistry::size ( void  ) const

inline

Definition at line 67 of file MasterProductRegistry.h.

References print(), and productList_.

  {
    return productList_.size();
  }

void art::MasterProductRegistry::updateFromInputFile

(

ProductList const &

pl

)

Definition at line 44 of file MasterProductRegistry.cc.

{
  CET_ASSERT_ONLY_ONE_THREAD();
  updateProductLists_(pl);
  cet::for_all(productListUpdatedCallbacks_,
               [this](auto const& callback) { callback(productList_); });
}

void art::MasterProductRegistry::updateFromModule

(

std::unique_ptr< ProductList > &&

pl

)

Definition at line 35 of file MasterProductRegistry.cc.

Referenced by art::ProductRegistryHelper::registerProducts().

{
  CET_ASSERT_ONLY_ONE_THREAD();
  if (!pl)
    return;
  updateProductLists_(*pl);
}

void art::MasterProductRegistry::updateProductLists_ ( ProductList const &  pl )

private

Definition at line 104 of file MasterProductRegistry.cc.

References art::combinable().

Referenced by productProduced().

{
  for (auto const& val : pl) {
    auto const& pd = val.second;
    assert(!pd.produced());
    auto bk = BranchKey{pd};
    auto it = productList_.find(bk);
    if (it == productList_.end()) {
      // New product
      productList_.emplace(bk, pd);
      continue;
    }
    auto& found_pd = it->second;
    assert(combinable(found_pd, pd));
    found_pd.merge(pd);
  }
}

Member Data Documentation

bool art::MasterProductRegistry::allowExplicitRegistration_ {true}

private

Definition at line 84 of file MasterProductRegistry.h.

ProductList art::MasterProductRegistry::productList_ {}

private

Definition at line 87 of file MasterProductRegistry.h.

Referenced by productList(), and size().

std::vector<ProductListUpdatedCallback> art::MasterProductRegistry::productListUpdatedCallbacks_ {}

private

Definition at line 90 of file MasterProductRegistry.h.

std::array<bool, NumBranchTypes> art::MasterProductRegistry::productProduced_

private

Initial value:

{
    {false}}

Definition at line 88 of file MasterProductRegistry.h.

Referenced by productProduced().

---

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

• art/Persistency/Provenance/MasterProductRegistry.h
• art/Persistency/Provenance/MasterProductRegistry.cc