art::ProductRegistryHelper Class Reference

#include "ProductRegistryHelper.h"

Inheritance diagram for art::ProductRegistryHelper:

Public Member Functions
void	productList (ProductList *p)
void	registerProducts (MasterProductRegistry &mpr, ProductDescriptions &productsToRegister, ModuleDescription const &md)
template<typename P , BranchType B = InEvent>
void	produces (std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)
template<typename P , BranchType B>
TypeLabel const &	reconstitutes (std::string const &modLabel, std::string const &instanceName={})
template<BranchType B>
std::set< TypeLabel > const &	expectedProducts () const
template<typename P , art::BranchType B>
art::TypeLabel const &	reconstitutes (std::string const &emulatedModule, std::string const &instanceName)

Private Member Functions
TypeLabel const &	insertOrThrow (BranchType const bt, TypeLabel const &tl)

Private Attributes
std::array< std::set< TypeLabel >, NumBranchTypes >	typeLabelList_
std::unique_ptr< ProductList >	productList_

Detailed Description

Definition at line 81 of file ProductRegistryHelper.h.

Member Function Documentation

template<BranchType B>

std::set<TypeLabel> const& art::ProductRegistryHelper::expectedProducts ( ) const

inline

Definition at line 111 of file ProductRegistryHelper.h.

References B, and typeLabelList_.

  {
    return typeLabelList_[B];
  }

TypeLabel const& art::ProductRegistryHelper::insertOrThrow ( BranchType const  bt, TypeLabel const &  tl  )

inlineprivate

Definition at line 118 of file ProductRegistryHelper.h.

References art::TypeLabel::friendlyClassName(), art::errors::LogicError, art::TypeLabel::productInstanceName(), and typeLabelList_.

Referenced by produces(), and reconstitutes().

  {
    auto result = typeLabelList_[bt].insert(tl);
    if (!result.second) {
      throw Exception(errors::LogicError, "RegistrationFailure")
        << "The module being constructed attempted to "
        << "register conflicting products with:\n"
        << "friendlyClassName: " << tl.friendlyClassName()
        << " and instanceName: " << tl.productInstanceName() << ".\n";
    }
    return *result.first;
  }

template<typename P , art::BranchType B>

void art::ProductRegistryHelper::produces ( std::string const &  instanceName = {}, Persistable const  persistable = Persistable::Yes  )

inline

Definition at line 141 of file ProductRegistryHelper.h.

References B, insertOrThrow(), art::No, art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

Referenced by larg4::LArG4::LArG4(), art::MixHelper::produces(), recob::ChargedSpacePointCollectionCreator::produces(), and productList().

{
  verifyInstanceName(instanceName);
  TypeID const productType{typeid(P)};
  verifyFriendlyClassName(productType.friendlyClassName());
  bool const isTransient = (persistable == Persistable::No);
  insertOrThrow(
    B,
    TypeLabel{productType, instanceName, SupportsView<P>::value, isTransient});
}

void art::ProductRegistryHelper::productList ( ProductList *  p )

inline

Definition at line 86 of file ProductRegistryHelper.h.

References produces(), productList_, reconstitutes(), registerProducts(), and art::Yes.

  {
    productList_.reset(p);
  }

template<typename P , BranchType B>

TypeLabel const& art::ProductRegistryHelper::reconstitutes	(	std::string const &	modLabel,
		std::string const &	instanceName = {}
	)

Referenced by lris::LArRawInputDriver::LArRawInputDriver(), lris::LArRawInputDriverJP250L::LArRawInputDriverJP250L(), lris::LArRawInputDriverLongBo::LArRawInputDriverLongBo(), lris::LArRawInputDriverShortBo::LArRawInputDriverShortBo(), and productList().

template<typename P , art::BranchType B>

art::TypeLabel const& art::ProductRegistryHelper::reconstitutes	(	std::string const &	emulatedModule,
		std::string const &	instanceName
	)

Definition at line 155 of file ProductRegistryHelper.h.

References B, insertOrThrow(), art::detail::verifyFriendlyClassName(), and art::detail::verifyInstanceName().

{
  verifyModuleLabel(emulatedModule);
  verifyInstanceName(instanceName);
  TypeID const productType{typeid(P)};
  verifyFriendlyClassName(productType.friendlyClassName());
  return insertOrThrow(
    B,
    TypeLabel{
      productType, instanceName, SupportsView<P>::value, emulatedModule});
}

void art::ProductRegistryHelper::registerProducts	(	MasterProductRegistry &	mpr,
		ProductDescriptions &	productsToRegister,
		ModuleDescription const &	md
	)

Definition at line 59 of file ProductRegistryHelper.cc.

References art::MasterProductRegistry::addProductsFromModule(), art::InEvent, art::NumBranchTypes, productList_, typeLabelList_, and art::MasterProductRegistry::updateFromModule().

Referenced by art::Source< T >::finishProductRegistration_(), productList(), and art::ResultsProducer::registerProducts().

{
  // First update the MPR with any extant products.
  if (productList_) {
    cet::transform_all(*productList_,
                       back_inserter(productsToRegister),
                       [](auto const& pr) { return pr.second; });
    mpr.updateFromModule(move(productList_));
  }

  // Now go through products that will be produced in the current process.
  check_for_duplicate_Assns(typeLabelList_[InEvent]);

  ProductDescriptions descriptions;
  for (std::size_t ibt{}; ibt != NumBranchTypes; ++ibt) {
    auto const bt = static_cast<BranchType>(ibt);
    for (auto const& val : typeLabelList_[bt]) {
      BranchDescription pd{bt, val, md};
      productsToRegister.push_back(pd);
      descriptions.push_back(std::move(pd));
    }
  }
  mpr.addProductsFromModule(move(descriptions));
}

Member Data Documentation

std::unique_ptr<ProductList> art::ProductRegistryHelper::productList_

private

Definition at line 136 of file ProductRegistryHelper.h.

Referenced by productList(), and registerProducts().

std::array<std::set<TypeLabel>, NumBranchTypes> art::ProductRegistryHelper::typeLabelList_

private

Definition at line 131 of file ProductRegistryHelper.h.

Referenced by expectedProducts(), insertOrThrow(), and registerProducts().

---

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

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