#include "ProvenanceDumper.h"

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

Public Types
using	ModuleType = OutputModule

using	WorkerType = OutputWorker

using	PluginCollection_t = std::vector< std::unique_ptr< FileCatalogMetadataPlugin >>

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

bool	fileIsOpen () const

OutputFileStatus	fileStatus () const

virtual std::string const &	lastClosedFileName () const

SelectionsArray const &	keptProducts () const

bool	selected (BranchDescription const &) const

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

void	selectProducts (ProductTables const &)

void	doSelectProducts (ProductTables const &)

void	registerProducts (ProductDescriptions &)

BranchChildren const &	branchChildren () const

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)

hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const

std::set< std::string > const &	sharedResources () const

void	createQueues (SharedResources const &resources)

template<BranchType , typename... T>
void	serialize (T const &...resources)

template<BranchType , typename... T>
void	serializeExternal (T const &...resources)

Protected Member Functions
virtual void	doRegisterProducts (ProductDescriptions &, ModuleDescription const &)

std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

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

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

template<BranchType BT = InEvent, typename... T>
void	serialize (T const &...)

template<BranchType BT = InEvent, typename... T>
void	serializeExternal (T const &...)

template<BranchType BT = InEvent>
void	async ()

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 53 of file OutputModule.h.

using art::OutputModule::PluginCollection_t = std::vector<std::unique_ptr<FileCatalogMetadataPlugin>>

inherited

Definition at line 57 of file OutputModule.h.

using art::OutputModule::WorkerType = OutputWorker

inherited

Definition at line 54 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 157 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<BranchType BT = InEvent>

void art::detail::SharedModule::async ( )

inlineprotectedinherited

Definition at line 38 of file SharedModule.h.

References art::detail::SharedModule::asyncDeclared_, art::detail::SharedModule::implicit_serialize(), art::InEvent, and art::detail::SharedModule::serialize_for().

     {
       static_assert(
         BT == InEvent,
         "async is currently supported only for the 'InEvent' level.");
       asyncDeclared_ = true;
     }

template<typename DETAIL , typename Enable >

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

inlineoverrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 169 of file ProvenanceDumper.h.

   {
     impl_.beginJob();
   }

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

inherited

Definition at line 660 of file OutputModule.cc.

References art::OutputModule::branchChildren_.

   {
     return branchChildren_;
   }

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

void art::detail::SharedModule::createQueues ( SharedResources const & resources )

inherited

Definition at line 34 of file SharedModule.cc.

References art::detail::SharedModule::asyncDeclared_, util::cbegin(), util::cend(), art::detail::SharedModule::chain_, art::detail::SharedResources::createQueues(), e, util::empty(), art::errors::LogicError, and art::detail::SharedModule::resourceNames_.

Referenced by art::OutputModule::doBeginJob(), art::SharedFilter::setupQueues(), art::SharedProducer::setupQueues(), art::EDFilter::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDProducer::setupQueues(), and art::EDAnalyzer::setupQueues().

   {
     Exception e{errors::LogicError,
                 "An error occurred while processing scheduling options for a "
                 "module.\n"};
     if (asyncDeclared_) {
       if (empty(resourceNames_)) {
         return;
       }
       throw e
         << "async<art::InEvent>() cannot be called in combination with any "
            "serialize<art::InEvent>(...) calls.\n";
     }
 
     if (empty(resourceNames_)) {
       throw e << "Either 'async<art::InEvent>()' or "
                  "'serialize<art::InEvent>(...)'\n"
                  "must be called in a shared module's constructor.\n";
     }
     std::vector<std::string> const names(cbegin(resourceNames_),
                                          cend(resourceNames_));
     auto queues = resources.createQueues(names);
     chain_ = std::make_unique<SerialTaskQueueChain>(queues);
   }

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

protectedvirtualinherited

Definition at line 179 of file OutputModule.cc.

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

181 {}

void art::OutputModule::doSelectProducts ( ProductTables const & tables )

inherited

Definition at line 123 of file OutputModule.cc.

References art::combinable(), art::ProductTables::descriptions(), util::end(), art::for_each_branch_type(), art::OutputModule::groupSelector_, art::OutputModule::groupSelectorRules_, art::OutputModule::hasNewlyDroppedBranch_, art::OutputModule::keptProducts(), art::OutputModule::keptProducts_, art::OutputModule::selected(), and util::values().

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

   {
     // Note: The keptProducts_ data member records all of the
     // BranchDescription objects that may be persisted to disk.  Since
     // we do not reset it, the list never shrinks.  This behavior should
     // be reconsidered for future use cases of art.
     auto selectProductForBranchType = [this, &tables](BranchType const bt) {
       auto const& productList = tables.descriptions(bt);
       groupSelector_[bt] =
         std::make_unique<GroupSelector const>(groupSelectorRules_, productList);
       // TODO: See if we can collapse keptProducts_ and groupSelector into
       // a single object. See the notes in the header for GroupSelector
       // for more information.
       for (auto const& pd : productList | ::ranges::views::values) {
         if (pd.transient() || pd.dropped()) {
           continue;
         }
         if (selected(pd)) {
           // Here, we take care to merge the BranchDescription objects
           // if one was already present in the keptProducts list.
           auto& keptProducts = keptProducts_[bt];
           if (auto it = keptProducts.find(pd.productID());
               it != end(keptProducts)) {
             auto& found_pd = it->second;
             assert(combinable(found_pd, pd));
             found_pd.merge(pd);
           } else {
             // New product
             keptProducts.emplace(pd.productID(), pd);
           }
           continue;
         }
         hasNewlyDroppedBranch_[bt] = true;
       }
     };
     for_each_branch_type(selectProductForBranchType);
   }

template<typename DETAIL , typename Enable >

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

inlineoverrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 174 of file ProvenanceDumper.h.

   {
     impl_.endJob();
   }

bool art::OutputModule::fileIsOpen ( ) const

inherited

Definition at line 95 of file OutputModule.cc.

References art::OutputModule::isFileOpen().

   {
     return isFileOpen();
   }

OutputFileStatus art::OutputModule::fileStatus ( ) const

inherited

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

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

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

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

inherited

Definition at line 654 of file OutputModule.cc.

References art::OutputModule::hasNewlyDroppedBranch_.

   {
     return hasNewlyDroppedBranch_;
   }

SelectionsArray const & art::OutputModule::keptProducts ( ) const

inherited

Definition at line 640 of file OutputModule.cc.

References art::OutputModule::keptProducts_.

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

   {
     return keptProducts_;
   }

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

virtualinherited

Definition at line 117 of file OutputModule.cc.

References art::OutputModule::configuredFileName_.

   {
     return configuredFileName_;
   }

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(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::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";
   }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::OutputModule::registerProducts ( ProductDescriptions & producedProducts )

inherited

Definition at line 173 of file OutputModule.cc.

References art::OutputModule::doRegisterProducts(), and art::ModuleBase::moduleDescription().

   {
     doRegisterProducts(producedProducts, moduleDescription());
   }

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

inherited

Definition at line 646 of file OutputModule.cc.

References art::BranchDescription::branchType(), and art::OutputModule::groupSelector_.

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

   {
     auto const bt = pd.branchType();
     assert(groupSelector_[bt]);
     return groupSelector_[bt]->selected(pd);
   }

void art::OutputModule::selectProducts ( ProductTables const & tables )

inherited

Definition at line 162 of file OutputModule.cc.

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

   {
     doSelectProducts(tables);
     postSelectProducts();
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serialize ( T const & ... )

protectedinherited

Referenced by simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime(), simfilter::FilterSimPhotonTime::FilterSimPhotonTime(), art::detail::LegacyModule::LegacyModule(), and art::OutputModule::OutputModule().

template<BranchType , typename... T>

void art::detail::SharedModule::serialize ( T const &... resources )

inherited

Definition at line 83 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_resource().

   {
     serialize_for_resource(resources...);
   }

template<BranchType BT = InEvent, typename... T>

void art::detail::SharedModule::serializeExternal ( T const & ... )

protectedinherited

Referenced by wcls::WireCellToolkit::WireCellToolkit().

template<BranchType , typename... T>

void art::detail::SharedModule::serializeExternal ( T const &... resources )

inherited

Definition at line 90 of file SharedModule.h.

References art::detail::SharedModule::serialize_for_external_resource().

   {
     serialize_for_external_resource(resources...);
   }

SerialTaskQueueChain * art::detail::SharedModule::serialTaskQueueChain ( ) const

inherited

Definition at line 22 of file SharedModule.cc.

References art::detail::SharedModule::chain_.

   {
     return chain_.get();
   }

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

std::set< std::string > const & art::detail::SharedModule::sharedResources ( ) const

inherited

Definition at line 28 of file SharedModule.cc.

References art::detail::SharedModule::resourceNames_.

   {
     return resourceNames_;
   }

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

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

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

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

template<typename DETAIL , typename Enable >

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

inlineoverrideprivatevirtual

Implements art::OutputModule.

Definition at line 180 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 190 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 185 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 195 of file ProvenanceDumper.h.

template<typename DETAIL , typename Enable >

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

private

Definition at line 197 of file ProvenanceDumper.h.

template<typename DETAIL , typename Enable >

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

private

Definition at line 196 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

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 >