art::ProducingService Class Reference

#include "ProducingService.h"

Inheritance diagram for art::ProducingService:

Public Member Functions
	ProducingService ()
virtual	~ProducingService () noexcept
void	setModuleDescription (ModuleDescription const &)
void	registerCallbacks (ProducingServiceSignals &)
void	doPostReadRun (RunPrincipal &)
void	doPostReadSubRun (SubRunPrincipal &)
void	doPostReadEvent (EventPrincipal &)

Static Public Attributes
static constexpr bool	service_handle_allowed {false}

Private Member Functions
virtual void	postReadRun (Run &)
virtual void	postReadSubRun (SubRun &)
virtual void	postReadEvent (Event &)
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
ModuleContext	mc_ {ModuleContext::invalid()}

Detailed Description

Definition at line 17 of file ProducingService.h.

Constructor & Destructor Documentation

art::ProducingService::ProducingService

(

)

Definition at line 15 of file ProducingService.cc.

References art::produces, and ~ProducingService().

    : ProductRegistryHelper{product_creation_mode::produces}
  {}

art::ProducingService::~ProducingService ( )

virtualdefaultnoexcept

Referenced by ProducingService().

Member Function Documentation

void art::ProducingService::doPostReadEvent

(

EventPrincipal &

ep

)

Definition at line 54 of file ProducingService.cc.

References e, art::EventPrincipal::makeEvent(), mc_, and postReadEvent().

Referenced by registerCallbacks().

  {
    auto e = ep.makeEvent(mc_);
    postReadEvent(e);
    e.commitProducts(true, &expectedProducts<InEvent>());
  }

void art::ProducingService::doPostReadRun

(

RunPrincipal &

rp

)

Definition at line 38 of file ProducingService.cc.

References art::RangeSet::forRun(), art::RunPrincipal::makeRun(), mc_, postReadRun(), r, and art::RunPrincipal::runID().

Referenced by registerCallbacks().

  {
    auto r = rp.makeRun(mc_, RangeSet::forRun(rp.runID()));
    postReadRun(r);
    r.commitProducts();
  }

void art::ProducingService::doPostReadSubRun

(

SubRunPrincipal &

srp

)

Definition at line 46 of file ProducingService.cc.

References art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), mc_, postReadSubRun(), and art::SubRunPrincipal::subRunID().

Referenced by registerCallbacks().

  {
    auto sr = srp.makeSubRun(mc_, RangeSet::forSubRun(srp.subRunID()));
    postReadSubRun(sr);
    sr.commitProducts();
  }

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 art::Modifier::fillProductDescriptions(), and art::ProductRegistryHelper::registerProducts().

  {
    collector_.fillDescriptions(md);
  }

void art::ProducingService::postReadEvent ( Event &  )

privatevirtual

Definition at line 70 of file ProducingService.cc.

Referenced by doPostReadEvent().

  {}

void art::ProducingService::postReadRun ( Run &  )

privatevirtual

Reimplemented in geo::GeometryConfigurationWriter.

Definition at line 62 of file ProducingService.cc.

Referenced by doPostReadRun().

  {}

void art::ProducingService::postReadSubRun ( SubRun &  )

privatevirtual

Definition at line 66 of file ProducingService.cc.

Referenced by doPostReadSubRun().

  {}

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::ProducingService::registerCallbacks

(

ProducingServiceSignals &

cbReg

)

Definition at line 30 of file ProducingService.cc.

References doPostReadEvent(), doPostReadRun(), doPostReadSubRun(), art::ProducingServiceSignals::sPostReadEvent, art::ProducingServiceSignals::sPostReadRun, and art::ProducingServiceSignals::sPostReadSubRun.

  {
    cbReg.sPostReadRun.watch(this, &ProducingService::doPostReadRun);
    cbReg.sPostReadSubRun.watch(this, &ProducingService::doPostReadSubRun);
    cbReg.sPostReadEvent.watch(this, &ProducingService::doPostReadEvent);
  }

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 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);
  }

void art::ProducingService::setModuleDescription

(

ModuleDescription const &

md

)

Definition at line 21 of file ProducingService.cc.

References mc_.

  {
    // We choose the one-argument constructor since the path
    // information is irrelevant when the doPostRead* functions are
    // invoked.
    mc_ = ModuleContext{md};
  }

Member Data Documentation

ModuleContext art::ProducingService::mc_ {ModuleContext::invalid()}

private

Definition at line 43 of file ProducingService.h.

Referenced by doPostReadEvent(), doPostReadRun(), doPostReadSubRun(), and setModuleDescription().

constexpr bool art::ProducingService::service_handle_allowed {false}

static

Definition at line 19 of file ProducingService.h.

---

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

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