art::ProductRegistryHelper Class Reference

#include <ProductRegistryHelper.h>

Inheritance diagram for art::ProductRegistryHelper:

Public Member Functions
	ProductRegistryHelper (product_creation_mode)
	~ProductRegistryHelper ()
	ProductRegistryHelper (ProductRegistryHelper const &)=delete
	ProductRegistryHelper (ProductRegistryHelper &&)=delete
ProductRegistryHelper &	operator= (ProductRegistryHelper const &)=delete
ProductRegistryHelper &	operator= (ProductRegistryHelper &&)=delete
void	productList (std::unique_ptr< ProductList > p)
void	registerProducts (ProductDescriptions &productsToRegister, ModuleDescription const &md)
void	fillDescriptions (ModuleDescription const &md)
template<typename P , BranchType B>
TypeLabel const &	reconstitutes (std::string const &modLabel, std::string const &instanceName={})
template<BranchType B>
TypeLabelLookup_t const &	expectedProducts () const
template<typename P , BranchType B = InEvent>
void	produces (std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)
ProducesCollector &	producesCollector () noexcept

Private Attributes
std::unique_ptr< ProductList const >	productList_ {nullptr}
product_creation_mode	mode_
ProducesCollector	collector_

Detailed Description

Definition at line 39 of file ProductRegistryHelper.h.

Constructor & Destructor Documentation

art::ProductRegistryHelper::ProductRegistryHelper ( product_creation_mode  mode )

explicit

Definition at line 18 of file ProductRegistryHelper.cc.

    : mode_{mode}
  {}

art::ProductRegistryHelper::~ProductRegistryHelper ( )

default

art::ProductRegistryHelper::ProductRegistryHelper ( ProductRegistryHelper const &  )

delete

art::ProductRegistryHelper::ProductRegistryHelper ( ProductRegistryHelper &&  )

delete

Member Function Documentation

template<BranchType B>

TypeLabelLookup_t const & art::ProductRegistryHelper::expectedProducts ( ) const

inline

Definition at line 93 of file ProductRegistryHelper.h.

  {
    return collector_.expectedProducts(B);
  }

void art::ProductRegistryHelper::fillDescriptions

(

ModuleDescription const &

md

)

Definition at line 47 of file ProductRegistryHelper.cc.

  {
    collector_.fillDescriptions(md);
  }

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

delete

ProductRegistryHelper& art::ProductRegistryHelper::operator= ( ProductRegistryHelper &&  )

delete

template<typename P , art::BranchType B>

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

inline

Definition at line 100 of file ProductRegistryHelper.h.

  {
    if (mode_ == product_creation_mode::reconstitutes) {
      throw Exception{errors::ProductRegistrationFailure,
                      "An error occurred while registering a product.\n"}
        << "The following product was registered with 'produces' when\n"
           "'reconstitutes' should have been called instead.\n"
        << "  Branch type: " << B << '\n'
        << "  Class name: " << cet::demangle_symbol(typeid(P).name()) << '\n'
        << "  Instance name: '" << instanceName << "'\n";
    }
    collector_.produces<P, B>(instanceName, persistable);
  }

ProducesCollector& art::ProductRegistryHelper::producesCollector ( )

inlinenoexcept

Definition at line 80 of file ProductRegistryHelper.h.

    {
      return collector_;
    }

void art::ProductRegistryHelper::productList ( std::unique_ptr< ProductList >  p )

inline

Definition at line 52 of file ProductRegistryHelper.h.

    {
      productList_ = move(p);
    }

template<typename P , BranchType B>

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

Definition at line 117 of file ProductRegistryHelper.h.

  {
    if (mode_ == product_creation_mode::produces) {
      throw Exception{errors::ProductRegistrationFailure,
                      "An error occurred while registering a product.\n"}
        << "The following product was registered with 'reconstitutes' when\n"
           "'produces' should have been called instead.\n"
        << "  Branch type: " << B << '\n'
        << "  Class name: " << cet::demangle_symbol(typeid(P).name()) << '\n'
        << "  Emulated module name: '" << emulatedModule << "'\n"
        << "  Instance name: '" << instanceName << "'\n";
    }
    return collector_.reconstitutes<P, B>(emulatedModule, instanceName);
  }

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

Definition at line 23 of file ProductRegistryHelper.cc.

  {
    // Possible products from input source
    if (productList_) {
      cet::transform_all(*productList_,
                         back_inserter(productsToRegister),
                         [](auto const& pr) { return pr.second; });
    }

    // Now fill the descriptions for products that are to be produced.
    fillDescriptions(md);
    auto registerProductsPerBT = [this,
                                  &productsToRegister](BranchType const bt) {
      auto const& expectedProducts = collector_.expectedProducts(bt);
      for (auto const& pr : expectedProducts) {
        productsToRegister.push_back(pr.second);
      }
    };
    for_each_branch_type(registerProductsPerBT);
  }

Member Data Documentation

ProducesCollector art::ProductRegistryHelper::collector_

private

Definition at line 88 of file ProductRegistryHelper.h.

product_creation_mode art::ProductRegistryHelper::mode_

private

Definition at line 87 of file ProductRegistryHelper.h.

std::unique_ptr<ProductList const> art::ProductRegistryHelper::productList_ {nullptr}

private

Definition at line 86 of file ProductRegistryHelper.h.

---

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

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