#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 19 of file ProductRegistryHelper.cc.

20 : mode_{mode}

21 {}

art::ProductRegistryHelper::mode_

product_creation_mode mode_

Definition: ProductRegistryHelper.h:87

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.

Referenced by registerProducts().

   {
     return collector_.expectedProducts(B);
   }

void art::ProductRegistryHelper::fillDescriptions ( ModuleDescription const & md )

Definition at line 48 of file ProductRegistryHelper.cc.

References collector_, and art::ProducesCollector::fillDescriptions().

Referenced by art::Modifier::fillProductDescriptions(), and registerProducts().

   {
     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.

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

Referenced by larg4::LArG4::LArG4(), trkf::PMAlgTrackMaker::PMAlgTrackMaker(), trkf::PMAlgTrajFitter::PMAlgTrajFitter(), and trkf::Track3DKalmanHit::Track3DKalmanHit().

   {
     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.

Referenced by apa::APAHitFinder::APAHitFinder(), artg4tk::artg4tkMain::artg4tkMain(), lar_cluster3d::Cluster3D::Cluster3D(), cluster::ClusterCrawler::ClusterCrawler(), CRHitRemoval::CRHitRemoval(), hit::DisambigCheater::DisambigCheater(), hit::DPRawHitFinder::DPRawHitFinder(), nnet::EmTrackClusterId::EmTrackClusterId(), nnet::EmTrackClusterId2out::EmTrackClusterId2out(), nnet::EmTrackClusterId2outTl::EmTrackClusterId2outTl(), nnet::EmTrackClusterId3outTl::EmTrackClusterId3outTl(), nnet::EmTrackMichelId::EmTrackMichelId(), nnet::EmTrackMichelIdTl::EmTrackMichelIdTl(), hit::FFTHitFinder::FFTHitFinder(), hit::GausHitFinder::GausHitFinder(), hit::HitCheater::HitCheater(), hit::HitFinder::HitFinder(), larg4::larg4Main::larg4Main(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), cluster::LineCluster::LineCluster(), art::MixFilter< T, IOPolicy >::MixFilter(), hit::RawHitFinder::RawHitFinder(), wcls::WireCellToolkit::reconfigure(), hit::RFFHitFinder::RFFHitFinder(), cluster::TrajCluster::TrajCluster(), and hit::TTHitFinder::TTHitFinder().

     {
       return collector_;
     }

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

inline

Definition at line 52 of file ProductRegistryHelper.h.

References art::produces, art::reconstitutes, and art::Yes.

     {
       productList_ = std::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.

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

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

   {
     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 24 of file ProductRegistryHelper.cc.

References collector_, expectedProducts(), art::ProducesCollector::expectedProducts(), fillDescriptions(), art::for_each_branch_type(), productList_, and util::values().

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

   {
     // 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& pd : expectedProducts | ::ranges::views::values) {
         productsToRegister.push_back(pd);
       }
     };
     for_each_branch_type(registerProductsPerBT);
   }