#include "ProvenanceDumper.h"

Inheritance diagram for art::ProvenanceDumper< DETAIL, Enable >:

Public Types
using	ModuleType = OutputModule

using	WorkerType = OutputWorker

Public Member Functions
	ProvenanceDumper (fhicl::ParameterSet const &ps)

int	maxEvents () const

int	remainingEvents () const

bool	fileIsOpen () const

OutputFileStatus	fileStatus () const

virtual std::string const &	lastClosedFileName () const

bool	selected (BranchDescription const &) const

SelectionsArray const &	keptProducts () const

std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const

BranchChildren const &	branchChildren () const

void	selectProducts (ProductList const &)

void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)

bool	modifiesEvent () const

std::string const &	processName () const

bool	wantAllEvents () const

bool	wantEvent (Event const &e)

fhicl::ParameterSetID	selectorConfig () const

art::Handle< art::TriggerResults >	getTriggerResults (Event const &e) const

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

ModuleDescription const &	description () const

virtual void	postSelectProducts ()

virtual void	doRegisterProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)

detail::CachedProducts &	cachedProducts ()

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Member Functions
void	beginJob () override

void	endJob () override

void	write (EventPrincipal &e) override

void	writeSubRun (SubRunPrincipal &sr) override

void	writeRun (RunPrincipal &r) override

Private Attributes
DETAIL	detail_

detail::PrincipalProcessor< DETAIL >	pp_

detail::ProvenanceDumperImpl< DETAIL >	impl_

Detailed Description

template<typename DETAIL, typename Enable>
class art::ProvenanceDumper< DETAIL, Enable >

Definition at line 129 of file ProvenanceDumper.h.

Member Typedef Documentation

using art::OutputModule::ModuleType = OutputModule

inherited

Definition at line 61 of file OutputModule.h.

using art::OutputModule::WorkerType = OutputWorker

inherited

Definition at line 62 of file OutputModule.h.

Constructor & Destructor Documentation

template<typename DETAIL , typename Enable >

art::ProvenanceDumper< DETAIL, Enable >::ProvenanceDumper ( fhicl::ParameterSet const & ps )

inlineexplicit

Definition at line 159 of file ProvenanceDumper.h.

References fhicl::ParameterSet::get().

     : OutputModule{ps}
     , detail_{ps}
     , pp_{detail_,
           ps.get<bool>("wantPresentOnly", true),
           ps.get<bool>("resolveProducts", true),
           ps.get<bool>("wantResolvedOnly", false)}
     , impl_{detail_, pp_}
   {}

Member Function Documentation

template<typename DETAIL , typename Enable >

void art::ProvenanceDumper< DETAIL, Enable >::beginJob ( )

inlineoverrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 171 of file ProvenanceDumper.h.

   {
     impl_.beginJob();
   }

art::BranchChildren const & art::OutputModule::branchChildren ( ) const

inlineinherited

Definition at line 349 of file OutputModule.h.

References art::OutputModule::branchChildren_.

Referenced by art::OutputModule::fileIsOpen(), and art::RootOutputFile::writeProductDependencies().

 {
   return branchChildren_;
 }

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

Referenced by art::EDAnalyzer::doEvent(), and art::OutputModule::doWriteEvent().

   {
     return selectors_;
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

art::CurrentProcessingContext const * art::OutputModule::currentContext ( ) const

inlineprotectedinherited

Definition at line 305 of file OutputModule.h.

References art::OutputModule::current_context_.

Referenced by art::OutputModule::fileIsOpen().

 {
   return current_context_.get();
 }

art::ModuleDescription const & art::OutputModule::description ( ) const

inlineprotectedinherited

Definition at line 311 of file OutputModule.h.

References art::OutputModule::moduleDescription_.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::fileIsOpen(), art::OutputModule::makePlugins_(), and art::RootOutput::startEndFile().

 {
   return moduleDescription_;
 }

void art::OutputModule::doRegisterProducts	(	MasterProductRegistry &	,
		ProductDescriptions &	,
		ModuleDescription const &
	)

protectedvirtualinherited

Reimplemented in art::RootOutput.

Definition at line 117 of file OutputModule.cc.

Referenced by art::OutputModule::fileIsOpen(), and art::OutputModule::registerProducts().

120 {}

template<typename DETAIL , typename Enable >

void art::ProvenanceDumper< DETAIL, Enable >::endJob ( )

inlineoverrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 176 of file ProvenanceDumper.h.

   {
     impl_.endJob();
   }

bool art::OutputModule::fileIsOpen ( ) const

inlineinherited

Definition at line 104 of file OutputModule.h.

References art::OutputModule::branchChildren(), art::OutputModule::currentContext(), art::OutputModule::description(), art::OutputModule::doRegisterProducts(), art::OutputModule::fileStatus(), art::OutputModule::hasNewlyDroppedBranch(), art::OutputModule::isFileOpen(), art::OutputModule::keptProducts(), art::OutputModule::lastClosedFileName(), art::OutputModule::postSelectProducts(), art::OutputModule::registerProducts(), art::OutputModule::selected(), and art::OutputModule::selectProducts().

Referenced by art::OutputWorker::fileIsOpen().

   {
     return isFileOpen();
   }

OutputFileStatus art::OutputModule::fileStatus ( ) const

inherited

Referenced by art::OutputModule::fileIsOpen().

art::Handle<art::TriggerResults> art::EventObserverBase::getTriggerResults ( Event const & e ) const

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

   {
     return selectors_.getOneTriggerResults(e);
   }

auto art::OutputModule::hasNewlyDroppedBranch ( ) const

inlineinherited

Definition at line 342 of file OutputModule.h.

References art::OutputModule::hasNewlyDroppedBranch_.

Referenced by art::OutputModule::fileIsOpen(), art::RootOutput::startEndFile(), art::RootOutput::write(), art::RootOutput::writeRun(), and art::RootOutput::writeSubRun().

 {
   return hasNewlyDroppedBranch_;
 }

auto art::OutputModule::keptProducts ( ) const

inlineinherited

Definition at line 336 of file OutputModule.h.

References art::OutputModule::keptProducts_.

Referenced by art::OutputModule::fileIsOpen(), and art::RootOutputFile::selectProducts().

 {
   return keptProducts_;
 }

string const & art::OutputModule::lastClosedFileName ( ) const

virtualinherited

Reimplemented in art::RootOutput.

Definition at line 58 of file OutputModule.cc.

References art::OutputModule::configuredFileName_.

Referenced by art::OutputModule::fileIsOpen(), and art::OutputWorker::lastClosedFileName().

 {
   return configuredFileName_;
 }

int art::OutputModule::maxEvents ( ) const

inlineinherited

Definition at line 317 of file OutputModule.h.

References art::OutputModule::maxEvents_.

 {
   return maxEvents_;
 }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

   {
     return false;
   }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::OutputModule::postSelectProducts ( )

protectedvirtualinherited

Reimplemented in art::RootOutput.

Definition at line 113 of file OutputModule.cc.

Referenced by art::OutputModule::fileIsOpen(), and art::OutputModule::selectProducts().

114 {}

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

   {
     return process_name_;
   }

void art::OutputModule::registerProducts	(	MasterProductRegistry &	mpr,
		ProductDescriptions &	producedProducts,
		ModuleDescription const &	md
	)

inherited

Definition at line 105 of file OutputModule.cc.

References art::OutputModule::doRegisterProducts().

Referenced by art::OutputModule::fileIsOpen().

 {
   doRegisterProducts(mpr, producedProducts, md);
 }

int art::OutputModule::remainingEvents ( ) const

inlineinherited

Definition at line 323 of file OutputModule.h.

References art::OutputModule::remainingEvents_.

Referenced by art::RootOutput::respondToOpenInputFile().

 {
   return remainingEvents_;
 }

bool art::OutputModule::selected ( BranchDescription const & pd ) const

inlineinherited

Definition at line 329 of file OutputModule.h.

References art::OutputModule::groupSelector_.

Referenced by art::OutputModule::doSelectProducts(), and art::OutputModule::fileIsOpen().

 {
   assert(groupSelector_);
   return groupSelector_->selected(pd);
 }

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

   {
     return selector_config_id_;
   }

void art::OutputModule::selectProducts ( ProductList const & productList )

inherited

Definition at line 98 of file OutputModule.cc.

References art::OutputModule::doSelectProducts(), and art::OutputModule::postSelectProducts().

Referenced by art::OutputModule::fileIsOpen(), and art::OutputWorker::selectProducts().

 {
   doSelectProducts(productList);
   postSelectProducts();
 }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

   {
     return wantAllEvents_;
   }

bool art::EventObserverBase::wantEvent ( Event const & e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), and art::OutputModule::doWriteEvent().

   {
     return selectors_.wantEvent(e);
   }

template<typename DETAIL , typename Enable >

void art::ProvenanceDumper< DETAIL, Enable >::write ( EventPrincipal & e )

inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 182 of file ProvenanceDumper.h.

   {
     impl_.write(e);
   }

template<typename DETAIL , typename Enable >

void art::ProvenanceDumper< DETAIL, Enable >::writeRun ( RunPrincipal & r )

inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 192 of file ProvenanceDumper.h.

   {
     impl_.writeRun(r);
   }

template<typename DETAIL , typename Enable >

void art::ProvenanceDumper< DETAIL, Enable >::writeSubRun ( SubRunPrincipal & sr )

inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 187 of file ProvenanceDumper.h.

   {
     impl_.writeSubRun(sr);
   }

Member Data Documentation

template<typename DETAIL , typename Enable >

DETAIL art::ProvenanceDumper< DETAIL, Enable >::detail_

private

Definition at line 197 of file ProvenanceDumper.h.

template<typename DETAIL , typename Enable >

detail::ProvenanceDumperImpl<DETAIL> art::ProvenanceDumper< DETAIL, Enable >::impl_

private

Definition at line 199 of file ProvenanceDumper.h.

template<typename DETAIL , typename Enable >

detail::PrincipalProcessor<DETAIL> art::ProvenanceDumper< DETAIL, Enable >::pp_

private

Definition at line 198 of file ProvenanceDumper.h.

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

art/Framework/Modules/ProvenanceDumper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename DETAIL, typename Enable> class art::ProvenanceDumper< DETAIL, Enable >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename DETAIL, typename Enable>
class art::ProvenanceDumper< DETAIL, Enable >