art::Modifier Class Reference

#include "Modifier.h"

Inheritance diagram for art::Modifier:

Public Types
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
void	fillProductDescriptions ()
void	registerProducts (ProductDescriptions &productsToRegister)
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
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

Detailed Description

Definition at line 16 of file Modifier.h.

Member Typedef Documentation

template<typename UserConfig , typename UserKeysToIgnore = void>

using art::Modifier::Table = ProducerTable<UserConfig, detail::ModuleConfig, UserKeysToIgnore>

Definition at line 20 of file Modifier.h.

Constructor & Destructor Documentation

art::Modifier::~Modifier ( )

defaultnoexcept

art::Modifier::Modifier

(

)

Definition at line 6 of file Modifier.cc.

References art::produces.

                     : ProductRegistryHelper{product_creation_mode::produces}
  {}

art::Modifier::Modifier ( Modifier const &  )

delete

art::Modifier::Modifier ( Modifier &&  )

delete

Member Function Documentation

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const &  tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

  {
    return collector_.consumes<T, BT>(tag);
  }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

  {
    return collector_;
  }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

  {
    collector_.consumesMany<T, BT>();
  }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const &  )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const &  tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

  {
    return collector_.consumesView<T, BT>(tag);
  }

template<BranchType B>

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

inlineinherited

Definition at line 93 of file ProductRegistryHelper.h.

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

  {
    return collector_.expectedProducts(B);
  }

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

inherited

Definition at line 48 of file ProductRegistryHelper.cc.

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

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

  {
    collector_.fillDescriptions(md);
  }

void art::Modifier::fillProductDescriptions

(

)

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

  {
    ProductRegistryHelper::fillDescriptions(moduleDescription());
  }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

  {
    return collector_.getConsumables();
  }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const &  wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

  {
    return doMakeWorker(wp);
  }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const &  tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

  {
    return collector_.mayConsume<T, BT>(tag);
  }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

  {
    collector_.mayConsumeMany<T, BT>();
  }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const &  )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const &  tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

  {
    return collector_.mayConsumeView<T, BT>(tag);
  }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), registerProducts(), and art::OutputModule::registerProducts().

  {
    if (md_.has_value()) {
      return *md_;
    }

    throw Exception{errors::LogicError,
                    "There was an error while calling moduleDescription().\n"}
      << "The moduleDescription() base-class member function cannot be called\n"
         "during module construction.  To determine which module is "
         "responsible\n"
         "for calling it, find the '<module type>:<module "
         "label>@Construction'\n"
         "tag in the message prefix above.  Please contact artists@fnal.gov\n"
         "for guidance.\n";
  }

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

delete

Modifier& art::Modifier::operator= ( Modifier &&  )

delete

template<typename P , art::BranchType B>

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

inlineinherited

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 ( )

inlinenoexceptinherited

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 )

inlineinherited

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 = {}  )

inherited

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::Modifier::registerProducts

(

ProductDescriptions &

productsToRegister

)

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

  {
    ProductRegistryHelper::registerProducts(productsToRegister,
                                            moduleDescription());
  }

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

inherited

Definition at line 24 of file ProductRegistryHelper.cc.

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

Referenced by art::Source< T >::finishProductRegistration_(), and 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);
  }

void art::ModuleBase::setModuleDescription ( ModuleDescription const &  md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

  {
    md_ = md;
  }

void art::ModuleBase::sortConsumables ( std::string const &  current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

  {
    // Now that we know we have seen all the consumes declarations,
    // sort the results for fast lookup later.
    collector_.sortConsumables(current_process_name);
  }

---

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

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