#include "OutputModule.h"

Inheritance diagram for art::OutputModule:

Classes
struct	Config

Public Types
using	ModuleType = OutputModule

using	WorkerType = OutputWorker

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

Public Member Functions
virtual	~OutputModule ()

	OutputModule (fhicl::ParameterSet const &pset)

	OutputModule (fhicl::TableFragment< Config > const &pset)

	OutputModule (OutputModule const &)=delete

	OutputModule (OutputModule &&)=delete

OutputModule &	operator= (OutputModule const &)=delete

OutputModule &	operator= (OutputModule &&)=delete

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 Types
using	BranchParents = std::map< ProductID, std::set< ParentageID >>

Private Member Functions
std::unique_ptr< Worker >	doMakeWorker (WorkerParams const &wp) final

void	configure (OutputModuleDescription const &desc)

virtual void	doBeginJob (detail::SharedResources const &resources)

virtual void	postSelectProducts ()

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal const &rp, ModuleContext const &)

bool	doEndRun (RunPrincipal const &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal const &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal const &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal const &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

void	doWriteRun (RunPrincipal &rp)

void	doWriteSubRun (SubRunPrincipal &srp)

void	doWriteEvent (EventPrincipal &ep, ModuleContext const &mc)

void	doSetRunAuxiliaryRangeSetID (RangeSet const &)

void	doSetSubRunAuxiliaryRangeSetID (RangeSet const &)

bool	doCloseFile ()

bool	doOpenFile (FileBlock const &fb)

void	reallyCloseFile ()

virtual void	incrementInputFileNumber ()

virtual bool	requestsToCloseFile () const

virtual Granularity	fileGranularity () const

virtual void	setFileStatus (OutputFileStatus)

virtual void	beginJob ()

virtual void	endJob ()

virtual void	beginRun (RunPrincipal const &)

virtual void	endRun (RunPrincipal const &)

virtual void	writeRun (RunPrincipal &r)=0

virtual void	setRunAuxiliaryRangeSetID (RangeSet const &)

virtual void	beginSubRun (SubRunPrincipal const &)

virtual void	endSubRun (SubRunPrincipal const &)

virtual void	writeSubRun (SubRunPrincipal &sr)=0

virtual void	setSubRunAuxiliaryRangeSetID (RangeSet const &)

virtual void	event (EventPrincipal const &)

virtual void	write (EventPrincipal &e)=0

virtual void	openFile (FileBlock const &)

virtual void	respondToOpenInputFile (FileBlock const &)

virtual void	readResults (ResultsPrincipal const &resp)

virtual void	respondToCloseInputFile (FileBlock const &)

virtual void	respondToOpenOutputFiles (FileBlock const &)

virtual void	respondToCloseOutputFiles (FileBlock const &)

virtual bool	isFileOpen () const

void	updateBranchParents (EventPrincipal &ep)

void	fillDependencyGraph ()

virtual void	startEndFile ()

virtual void	writeFileFormatVersion ()

virtual void	writeFileIdentifier ()

virtual void	writeFileIndex ()

virtual void	writeProcessConfigurationRegistry ()

virtual void	writeProcessHistoryRegistry ()

virtual void	writeParameterSetRegistry ()

virtual void	writeParentageRegistry ()

virtual void	writeProductDescriptionRegistry ()

void	writeFileCatalogMetadata ()

virtual void	doWriteFileCatalogMetadata (FileCatalogMetadata::collection_type const &md, FileCatalogMetadata::collection_type const &ssmd)

virtual void	writeProductDependencies ()

virtual void	finishEndFile ()

PluginCollection_t	makePlugins_ (std::vector< fhicl::ParameterSet > const &psets)

Private Attributes
SelectionsArray	keptProducts_ {{}}

std::array< std::unique_ptr< GroupSelector const >, NumBranchTypes >	groupSelector_ {{nullptr}}

std::array< bool, NumBranchTypes >	hasNewlyDroppedBranch_ {{false}}

GroupSelectorRules	groupSelectorRules_

std::map< ProductID, std::set< ParentageID > >	branchParents_ {}

BranchChildren	branchChildren_ {}

std::string	configuredFileName_

std::string	dataTier_

std::string	streamName_

ServiceHandle< CatalogInterface >	ci_ {}

cet::BasicPluginFactory	pluginFactory_ {}

std::vector< std::string >	pluginNames_ {}

PluginCollection_t	plugins_

Friends
class	OutputWorker

Detailed Description

Definition at line 49 of file OutputModule.h.

Member Typedef Documentation

using art::OutputModule::BranchParents = std::map<ProductID, std::set<ParentageID>>

private

Definition at line 231 of file OutputModule.h.

using art::OutputModule::ModuleType = OutputModule

Definition at line 53 of file OutputModule.h.

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

Definition at line 57 of file OutputModule.h.

using art::OutputModule::WorkerType = OutputWorker

Definition at line 54 of file OutputModule.h.

Constructor & Destructor Documentation

art::OutputModule::~OutputModule ( )

virtualdefault

art::OutputModule::OutputModule ( fhicl::ParameterSet const & pset )

explicit

Definition at line 74 of file OutputModule.cc.

References configuredFileName_, dataTier_, groupSelectorRules_, art::detail::LegacyResource, makePlugins_(), plugins_, art::detail::SharedModule::serialize(), and streamName_.

     : Observer{pset}
     , groupSelectorRules_{pset.get<vector<string>>("outputCommands",
                                                    {"keep *"}),
                           "outputCommands",
                           "OutputModule"}
     , configuredFileName_{pset.get<string>("fileName", "")}
     , dataTier_{pset.get<string>("dataTier", "")}
     , streamName_{pset.get<string>("streamName", "")}
     , plugins_{makePlugins_(pset.get<vector<ParameterSet>>("FCMDPlugins", {}))}
   {
     serialize(detail::LegacyResource);
   }

art::OutputModule::OutputModule ( fhicl::TableFragment< Config > const & pset )

explicit

Definition at line 57 of file OutputModule.cc.

References configuredFileName_, dataTier_, groupSelectorRules_, art::detail::LegacyResource, makePlugins_(), plugins_, art::detail::SharedModule::serialize(), and streamName_.

     : Observer{config().eoFragment().selectEvents(),
                config().eoFragment().rejectEvents()}
     , groupSelectorRules_{config().outputCommands(),
                           "outputCommands",
                           "OutputModule"}
     , configuredFileName_{config().fileName()}
     , dataTier_{config().dataTier()}
     , streamName_{config().streamName()}
   {
     std::vector<ParameterSet> fcmdPluginPSets;
     if (config().fcmdPlugins.get_if_present(fcmdPluginPSets)) {
       plugins_ = makePlugins_(fcmdPluginPSets);
     }
     serialize(detail::LegacyResource);
   }

art::OutputModule::OutputModule ( OutputModule const & )

delete

art::OutputModule::OutputModule ( OutputModule && )

delete

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

void art::OutputModule::beginJob ( )

privatevirtual

Reimplemented in art::ProvenanceDumper< DETAIL, std::void_t< typename DETAIL::Config > >, and art::ProvenanceDumper< DETAIL, Enable >.

Definition at line 425 of file OutputModule.cc.

Referenced by doBeginJob().

426 {}

void art::OutputModule::beginRun ( RunPrincipal const & )

privatevirtual

Definition at line 437 of file OutputModule.cc.

Referenced by doBeginRun().

438 {}

void art::OutputModule::beginSubRun ( SubRunPrincipal const & )

privatevirtual

Definition at line 445 of file OutputModule.cc.

Referenced by doBeginSubRun().

446 {}

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

Definition at line 660 of file OutputModule.cc.

References branchChildren_.

   {
     return branchChildren_;
   }

void art::OutputModule::configure ( OutputModuleDescription const & desc )

private

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 doBeginJob(), art::SharedFilter::setupQueues(), art::SharedProducer::setupQueues(), art::SharedAnalyzer::setupQueues(), art::EDFilter::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::doBeginJob ( detail::SharedResources const & resources )

privatevirtual

Definition at line 184 of file OutputModule.cc.

References beginJob(), art::detail::SharedModule::createQueues(), and plugins_.

   {
     createQueues(resources);
     beginJob();
     cet::for_all(plugins_, [](auto& p) { p->doBeginJob(); });
   }

bool art::OutputModule::doBeginRun	(	RunPrincipal const &	rp,
		ModuleContext const &	mc
	)

private

Definition at line 192 of file OutputModule.cc.

References beginRun(), FDEBUG, art::RunPrincipal::makeRun(), plugins_, and r.

   {
     FDEBUG(2) << "beginRun called\n";
     beginRun(rp);
     auto const r = rp.makeRun(mc);
     cet::for_all(plugins_, [&r](auto& p) { p->doBeginRun(r); });
     return true;
   }

bool art::OutputModule::doBeginSubRun	(	SubRunPrincipal const &	srp,
		ModuleContext const &	mc
	)

private

Definition at line 202 of file OutputModule.cc.

References beginSubRun(), FDEBUG, art::SubRunPrincipal::makeSubRun(), and plugins_.

   {
     FDEBUG(2) << "beginSubRun called\n";
     beginSubRun(srp);
     auto const sr = srp.makeSubRun(mc);
     cet::for_all(plugins_, [&sr](auto& p) { p->doBeginSubRun(sr); });
     return true;
   }

bool art::OutputModule::doCloseFile ( )

private

Definition at line 347 of file OutputModule.cc.

References isFileOpen(), and reallyCloseFile().

   {
     if (isFileOpen()) {
       reallyCloseFile();
       return true;
     }
     return false;
   }

void art::OutputModule::doEndJob ( )

private

Definition at line 296 of file OutputModule.cc.

References endJob(), and plugins_.

   {
     endJob();
     cet::for_all(plugins_, [](auto& p) { p->doEndJob(); });
   }

bool art::OutputModule::doEndRun	(	RunPrincipal const &	rp,
		ModuleContext const &	mc
	)

private

Definition at line 279 of file OutputModule.cc.

References endRun(), FDEBUG, art::RunPrincipal::makeRun(), plugins_, and r.

   {
     FDEBUG(2) << "endRun called\n";
     endRun(rp);
     auto const r = rp.makeRun(mc);
     cet::for_all(plugins_, [&r](auto& p) { p->doEndRun(r); });
     return true;
   }

bool art::OutputModule::doEndSubRun	(	SubRunPrincipal const &	srp,
		ModuleContext const &	mc
	)

private

Definition at line 255 of file OutputModule.cc.

References endSubRun(), FDEBUG, art::SubRunPrincipal::makeSubRun(), and plugins_.

   {
     FDEBUG(2) << "endSubRun called\n";
     endSubRun(srp);
     auto const sr = srp.makeSubRun(mc);
     cet::for_all(plugins_, [&sr](auto& p) { p->doEndSubRun(sr); });
     return true;
   }

bool art::OutputModule::doEvent	(	EventPrincipal const &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

private

Definition at line 213 of file OutputModule.cc.

References event(), FDEBUG, art::EventPrincipal::makeEvent(), art::ModuleContext::scheduleID(), and art::Observer::wantEvent().

   {
     FDEBUG(2) << "doEvent called\n";
     if (wantEvent(mc.scheduleID(), ep.makeEvent(mc))) {
       ++counts_run;
       event(ep);
       ++counts_passed;
     }
     return true;
   }

std::unique_ptr< Worker > art::OutputModule::doMakeWorker ( WorkerParams const & wp )

finalprivatevirtual

Implements art::ModuleBase.

Definition at line 89 of file OutputModule.cc.

   {
     return std::make_unique<OutputWorker>(this, wp);
   }

bool art::OutputModule::doOpenFile ( FileBlock const & fb )

private

Definition at line 303 of file OutputModule.cc.

References isFileOpen(), and openFile().

   {
     if (isFileOpen()) {
       return false;
     }
     openFile(fb);
     return true;
   }

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

protectedvirtual

Definition at line 179 of file OutputModule.cc.

Referenced by registerProducts().

181 {}

void art::OutputModule::doRespondToCloseInputFile ( FileBlock const & fb )

private

Definition at line 329 of file OutputModule.cc.

References respondToCloseInputFile().

   {
     respondToCloseInputFile(fb);
   }

void art::OutputModule::doRespondToCloseOutputFiles ( FileBlock const & fb )

private

Definition at line 341 of file OutputModule.cc.

References respondToCloseOutputFiles().

   {
     respondToCloseOutputFiles(fb);
   }

void art::OutputModule::doRespondToOpenInputFile ( FileBlock const & fb )

private

Definition at line 313 of file OutputModule.cc.

References art::ModuleBase::moduleDescription(), art::ModuleDescription::processConfiguration(), readResults(), respondToOpenInputFile(), and art::FileBlock::resultsPrincipal().

   {
     respondToOpenInputFile(fb);
     unique_ptr<ResultsPrincipal> respHolder;
     ResultsPrincipal const* respPtr = fb.resultsPrincipal();
     if (respPtr == nullptr) {
       respHolder = make_unique<ResultsPrincipal>(
         ResultsAuxiliary{},
         moduleDescription().processConfiguration(),
         nullptr);
       respPtr = respHolder.get();
     }
     readResults(*respPtr);
   }

void art::OutputModule::doRespondToOpenOutputFiles ( FileBlock const & fb )

private

Definition at line 335 of file OutputModule.cc.

References respondToOpenOutputFiles().

   {
     respondToOpenOutputFiles(fb);
   }

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

Definition at line 123 of file OutputModule.cc.

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

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

void art::OutputModule::doSetRunAuxiliaryRangeSetID ( RangeSet const & ranges )

private

Definition at line 272 of file OutputModule.cc.

References FDEBUG, and setRunAuxiliaryRangeSetID().

   {
     FDEBUG(2) << "writeAuxiliaryRangeSets(rp) called\n";
     setRunAuxiliaryRangeSetID(ranges);
   }

void art::OutputModule::doSetSubRunAuxiliaryRangeSetID ( RangeSet const & ranges )

private

Definition at line 249 of file OutputModule.cc.

References setSubRunAuxiliaryRangeSetID().

   {
     setSubRunAuxiliaryRangeSetID(ranges);
   }

void art::OutputModule::doWriteEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc
	)

private

Definition at line 229 of file OutputModule.cc.

References ci_, e, art::EventPrincipal::eventID(), FDEBUG, art::Observer::getTriggerResults(), art::ModuleBase::moduleDescription(), plugins_, art::ModuleContext::scheduleID(), updateBranchParents(), art::Observer::wantEvent(), and write().

   {
     FDEBUG(2) << "writeEvent called\n";
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       write(ep);
       // Declare that the event was selected for write to the catalog interface.
       Handle<TriggerResults> trHandle{getTriggerResults(e)};
       auto const& trRef(trHandle.isValid() ?
                           static_cast<HLTGlobalStatus>(*trHandle) :
                           HLTGlobalStatus{});
       ci_->eventSelected(
         moduleDescription().moduleLabel(), ep.eventID(), trRef);
       // ... and invoke the plugins:
       cet::for_all(plugins_, [&e](auto& p) { p->doCollectMetadata(e); });
       updateBranchParents(ep);
     }
   }

void art::OutputModule::doWriteFileCatalogMetadata	(	FileCatalogMetadata::collection_type const &	md,
		FileCatalogMetadata::collection_type const &	ssmd
	)

privatevirtual

Definition at line 596 of file OutputModule.cc.

Referenced by writeFileCatalogMetadata().

599 {}

void art::OutputModule::doWriteRun ( RunPrincipal & rp )

private

Definition at line 289 of file OutputModule.cc.

References FDEBUG, and writeRun().

   {
     FDEBUG(2) << "writeRun called\n";
     writeRun(rp);
   }

void art::OutputModule::doWriteSubRun ( SubRunPrincipal & srp )

private

Definition at line 265 of file OutputModule.cc.

References FDEBUG, and writeSubRun().

   {
     FDEBUG(2) << "writeSubRun called\n";
     writeSubRun(srp);
   }

void art::OutputModule::endJob ( )

privatevirtual

Reimplemented in art::ProvenanceDumper< DETAIL, std::void_t< typename DETAIL::Config > >, and art::ProvenanceDumper< DETAIL, Enable >.

Definition at line 429 of file OutputModule.cc.

Referenced by doEndJob().

430 {}

void art::OutputModule::endRun ( RunPrincipal const & )

privatevirtual

Definition at line 441 of file OutputModule.cc.

Referenced by doEndRun().

442 {}

void art::OutputModule::endSubRun ( SubRunPrincipal const & )

privatevirtual

Definition at line 449 of file OutputModule.cc.

Referenced by doEndSubRun().

450 {}

void art::OutputModule::event ( EventPrincipal const & )

privatevirtual

Definition at line 433 of file OutputModule.cc.

Referenced by doEvent().

434 {}

Granularity art::OutputModule::fileGranularity ( ) const

privatevirtual

Definition at line 111 of file OutputModule.cc.

References art::Granularity::Unset.

   {
     return Granularity::Unset;
   }

bool art::OutputModule::fileIsOpen ( ) const

Definition at line 95 of file OutputModule.cc.

References isFileOpen().

   {
     return isFileOpen();
   }

OutputFileStatus art::OutputModule::fileStatus ( ) const

void art::OutputModule::fillDependencyGraph ( )

private

Definition at line 409 of file OutputModule.cc.

References branchChildren_, branchParents_, art::thread_safe_registry_via_id< K, M >::get(), art::BranchChildren::insertChild(), and art::Parentage::parents().

Referenced by reallyCloseFile().

   {
     for (auto const& [child, eIds] : branchParents_) {
       for (auto const& eId : eIds) {
         Parentage par;
         if (!ParentageRegistry::get(eId, par)) {
           continue;
         }
         for (auto const& p : par.parents()) {
           branchChildren_.insertChild(p, child);
         }
       }
     }
   }

void art::OutputModule::finishEndFile ( )

privatevirtual

Definition at line 606 of file OutputModule.cc.

Referenced by reallyCloseFile().

607 {}

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

Definition at line 654 of file OutputModule.cc.

References hasNewlyDroppedBranch_.

   {
     return hasNewlyDroppedBranch_;
   }

void art::OutputModule::incrementInputFileNumber ( )

privatevirtual

Definition at line 101 of file OutputModule.cc.

102 {}

bool art::OutputModule::isFileOpen ( ) const

privatevirtual

Definition at line 485 of file OutputModule.cc.

Referenced by doCloseFile(), doOpenFile(), and fileIsOpen().

   {
     return true;
   }

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

Definition at line 640 of file OutputModule.cc.

References keptProducts_.

Referenced by doSelectProducts().

   {
     return keptProducts_;
   }

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

virtual

Definition at line 117 of file OutputModule.cc.

References configuredFileName_.

   {
     return configuredFileName_;
   }

OutputModule::PluginCollection_t art::OutputModule::makePlugins_ ( std::vector< fhicl::ParameterSet > const & psets )

private

Definition at line 610 of file OutputModule.cc.

References art::errors::Configuration, e, art::ModuleBase::moduleDescription(), art::ModuleDescription::moduleLabel(), pluginFactory_, pluginNames_, and value.

Referenced by OutputModule().

   {
     PluginCollection_t result;
     result.reserve(psets.size());
     size_t count{0};
     try {
       for (auto const& pset : psets) {
         auto const& libspec =
           pluginNames_.emplace_back(pset.get<string>("plugin_type"));
         auto const pluginType = pluginFactory_.pluginType(libspec);
         if (pluginType !=
             cet::PluginTypeDeducer<FileCatalogMetadataPlugin>::value) {
           throw Exception(errors::Configuration, "OutputModule: ")
             << "unrecognized plugin type " << pluginType << ".\n";
         }
         result.emplace_back(
           pluginFactory_.makePlugin<unique_ptr<FileCatalogMetadataPlugin>>(
             libspec, pset));
         ++count;
       }
     }
     catch (cet::exception& e) {
       throw Exception(errors::Configuration, "OutputModule: ", e)
         << "Exception caught while processing FCMDPlugins[" << count
         << "] in module " << moduleDescription().moduleLabel() << ".\n";
     }
     return result;
   }

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

void art::OutputModule::openFile ( FileBlock const & )

privatevirtual

Definition at line 461 of file OutputModule.cc.

Referenced by doOpenFile().

462 {}

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

delete

OutputModule& art::OutputModule::operator= ( OutputModule && )

delete

void art::OutputModule::postSelectProducts ( )

privatevirtual

Definition at line 169 of file OutputModule.cc.

Referenced by selectProducts().

170 {}

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::readResults ( ResultsPrincipal const & resp )

privatevirtual

Reimplemented in art::FileDumperOutput.

Definition at line 469 of file OutputModule.cc.

Referenced by doRespondToOpenInputFile().

470 {}

void art::OutputModule::reallyCloseFile ( )

private

Definition at line 357 of file OutputModule.cc.

References branchChildren_, branchParents_, art::BranchChildren::clear(), fillDependencyGraph(), finishEndFile(), startEndFile(), writeFileCatalogMetadata(), writeFileFormatVersion(), writeFileIdentifier(), writeFileIndex(), writeParameterSetRegistry(), writeParentageRegistry(), writeProcessConfigurationRegistry(), writeProcessHistoryRegistry(), writeProductDependencies(), and writeProductDescriptionRegistry().

Referenced by doCloseFile().

   {
     fillDependencyGraph();
     startEndFile();
     writeFileFormatVersion();
     writeFileIdentifier();
     writeFileIndex();
     writeProcessConfigurationRegistry();
     writeProcessHistoryRegistry();
     writeParameterSetRegistry();
     writeProductDescriptionRegistry();
     writeParentageRegistry();
     writeFileCatalogMetadata();
     writeProductDependencies();
     finishEndFile();
     branchParents_.clear();
     branchChildren_.clear();
   }

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

Definition at line 173 of file OutputModule.cc.

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

   {
     doRegisterProducts(producedProducts, moduleDescription());
   }

bool art::OutputModule::requestsToCloseFile ( ) const

privatevirtual

Definition at line 105 of file OutputModule.cc.

   {
     return false;
   }

void art::OutputModule::respondToCloseInputFile ( FileBlock const & )

privatevirtual

Definition at line 473 of file OutputModule.cc.

Referenced by doRespondToCloseInputFile().

474 {}

void art::OutputModule::respondToCloseOutputFiles ( FileBlock const & )

privatevirtual

Definition at line 481 of file OutputModule.cc.

Referenced by doRespondToCloseOutputFiles().

482 {}

void art::OutputModule::respondToOpenInputFile ( FileBlock const & )

privatevirtual

Definition at line 465 of file OutputModule.cc.

Referenced by doRespondToOpenInputFile().

466 {}

void art::OutputModule::respondToOpenOutputFiles ( FileBlock const & )

privatevirtual

Definition at line 477 of file OutputModule.cc.

Referenced by doRespondToOpenOutputFiles().

478 {}

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

Definition at line 646 of file OutputModule.cc.

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

Referenced by doSelectProducts().

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

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

Definition at line 162 of file OutputModule.cc.

References doSelectProducts(), and 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 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::OutputModule::setFileStatus ( OutputFileStatus )

privatevirtual

Definition at line 491 of file OutputModule.cc.

492 {}

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

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::OutputModule::setRunAuxiliaryRangeSetID ( RangeSet const & )

privatevirtual

Definition at line 453 of file OutputModule.cc.

Referenced by doSetRunAuxiliaryRangeSetID().

454 {}

void art::OutputModule::setSubRunAuxiliaryRangeSetID ( RangeSet const & )

privatevirtual

Definition at line 457 of file OutputModule.cc.

Referenced by doSetSubRunAuxiliaryRangeSetID().

458 {}

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

void art::OutputModule::startEndFile ( )

privatevirtual

Definition at line 495 of file OutputModule.cc.

Referenced by reallyCloseFile().

496 {}

void art::OutputModule::updateBranchParents ( EventPrincipal & ep )

private

Definition at line 379 of file OutputModule.cc.

References branchChildren_, branchParents_, and art::BranchChildren::insertEmpty().

Referenced by doWriteEvent().

   {
     // Note: threading: We are implicitly using the Principal
     //       iterators here which iterate over the groups held by the
     //       principal, which may be updated by a producer task in
     //       another stream while we are iterating! But only for Run,
     //       SubRun, and Results principals, in the case of Event
     //       principals we arrange that no producer or filter tasks
     //       are running when we run. So since we are only called for
     //       event principals we are safe.
     //
     // Note: threading: We update branchParents_ and branchChildren_
     //       here which must be protected if we become a stream or
     //       global module.
     //
     for (auto const& [pid, group] : ep) {
       if (auto provenance = group->productProvenance()) {
         auto iter = branchParents_.find(pid);
         if (iter == branchParents_.end()) {
           iter = branchParents_.emplace(pid, set<ParentageID>{}).first;
         }
         iter->second.insert(provenance->parentageID());
         branchChildren_.insertEmpty(pid);
       }
     }
   }

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

virtual void art::OutputModule::write ( EventPrincipal & e )

privatepure virtual

Implemented in art::ProvenanceDumper< DETAIL, std::void_t< typename DETAIL::Config > >, art::ProvenanceDumper< DETAIL, Enable >, art::FileDumperOutput, and art::ProvenanceCheckerOutput.

Referenced by doWriteEvent().

void art::OutputModule::writeFileCatalogMetadata ( )

private

Definition at line 573 of file OutputModule.cc.

References dataTier_, doWriteFileCatalogMetadata(), pluginNames_, plugins_, and streamName_.

Referenced by reallyCloseFile().

   {
     // Obtain metadata from service for output.
     FileCatalogMetadata::collection_type md;
     ServiceHandle<FileCatalogMetadata const>
     {
       } -> getMetadata(md);
     if (!dataTier_.empty()) {
       md.emplace_back("data_tier", cet::canonical_string(dataTier_));
     }
     if (!streamName_.empty()) {
       md.emplace_back("data_stream", cet::canonical_string(streamName_));
     }
     // Ask any plugins for their list of metadata, and put it in a
     // separate list for the output module. The user stream-specific
     // metadata should override stream-specific metadata generated by the
     // output module iself.
     FileCatalogMetadata::collection_type ssmd;
     collectStreamSpecificMetadata(plugins_, pluginNames_, ssmd);
     doWriteFileCatalogMetadata(md, ssmd);
   }