#include "OutputModule.h"

Inheritance diagram for art::OutputModule:

Classes
struct	Config

Public Types
using	ModuleType = OutputModule

using	WorkerType = OutputWorker

Public Member Functions
	OutputModule (OutputModule const &)=delete

OutputModule &	operator= (OutputModule const &)=delete

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

	OutputModule (fhicl::ParameterSet const &pset)

virtual	~OutputModule () noexcept=default

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

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

Private Member Functions
void	configure (OutputModuleDescription const &desc)

void	doBeginJob ()

void	doEndJob ()

bool	doEvent (EventPrincipal const &ep, CurrentProcessingContext const *cpc, CountingStatistics &)

bool	doBeginRun (RunPrincipal const &rp, CurrentProcessingContext const *cpc)

bool	doEndRun (RunPrincipal const &rp, CurrentProcessingContext const *cpc)

bool	doBeginSubRun (SubRunPrincipal const &srp, CurrentProcessingContext const *cpc)

bool	doEndSubRun (SubRunPrincipal const &srp, CurrentProcessingContext const *cpc)

void	doWriteRun (RunPrincipal &rp)

void	doWriteSubRun (SubRunPrincipal &srp)

void	doWriteEvent (EventPrincipal &ep)

void	doSetRunAuxiliaryRangeSetID (RangeSet const &)

void	doSetSubRunAuxiliaryRangeSetID (RangeSet const &)

void	doOpenFile (FileBlock const &fb)

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

void	doSelectProducts (ProductList const &)

std::string	workerType () const

void	doCloseFile ()

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	setModuleDescription (ModuleDescription const &md)

void	updateBranchParents (EventPrincipal const &ep)

void	fillDependencyGraph ()

bool	limitReached () const

virtual void	startEndFile ()

virtual void	writeFileFormatVersion ()

virtual void	writeFileIdentifier ()

virtual void	writeFileIndex ()

virtual void	writeEventHistory ()

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

virtual void	finishEndFile ()

PluginCollection_t	makePlugins_ (fhicl::ParameterSet const &top_pset)

Private Attributes
SelectionsArray	keptProducts_ {{}}

std::array< bool, NumBranchTypes >	hasNewlyDroppedBranch_

GroupSelectorRules	groupSelectorRules_

std::unique_ptr< GroupSelector const >	groupSelector_ {nullptr}

int	maxEvents_ {-1}

int	remainingEvents_ {maxEvents_}

ModuleDescription	moduleDescription_ {}

cet::exempt_ptr< CurrentProcessingContext const >	current_context_ {nullptr}

BranchParents	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
template<typename T >
class	WorkerT

class	OutputWorker

Detailed Description

Definition at line 53 of file OutputModule.h.

Member Typedef Documentation

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

private

Definition at line 168 of file OutputModule.h.

using art::OutputModule::ModuleType = OutputModule

Definition at line 61 of file OutputModule.h.

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

private

Definition at line 182 of file OutputModule.h.

using art::OutputModule::WorkerType = OutputWorker

Definition at line 62 of file OutputModule.h.

Constructor & Destructor Documentation

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

delete

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

explicit

Definition at line 34 of file OutputModule.cc.

References configuredFileName_, dataTier_, groupSelectorRules_, makePlugins_(), plugins_, and streamName_.

   : EventObserverBase{config().eoFragment().selectEvents(), containing_pset}
   , groupSelectorRules_{config().outputCommands(),
                         "outputCommands",
                         "OutputModule"}
   , configuredFileName_{config().fileName()}
   , dataTier_{config().dataTier()}
   , streamName_{config().streamName()}
   , plugins_{makePlugins_(containing_pset)}
 {}

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

explicit

Definition at line 46 of file OutputModule.cc.

References configuredFileName_, dataTier_, groupSelectorRules_, makePlugins_(), plugins_, and streamName_.

   : EventObserverBase{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)}
 {}

virtual art::OutputModule::~OutputModule ( )

virtualdefaultnoexcept

Member Function Documentation

void art::OutputModule::beginJob ( )

privatevirtual

Reimplemented in art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >, art::ProvenanceDumper< DETAIL, Enable >, and art::RootOutput.

Definition at line 361 of file OutputModule.cc.

Referenced by doBeginJob(), and fileGranularity().

362 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 373 of file OutputModule.cc.

Referenced by doBeginRun(), and fileGranularity().

374 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 381 of file OutputModule.cc.

Referenced by doBeginSubRun(), and fileGranularity().

382 {}

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

inline

Definition at line 349 of file OutputModule.h.

References branchChildren_.

Referenced by 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 doWriteEvent().

   {
     return selectors_;
   }

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

private

Definition at line 64 of file OutputModule.cc.

References art::OutputModuleDescription::maxEvents_, maxEvents_, and remainingEvents_.

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

 {
   remainingEvents_ = maxEvents_ = desc.maxEvents_;
 }

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

inlineprotected

Definition at line 305 of file OutputModule.h.

References current_context_.

Referenced by fileIsOpen().

 {
   return current_context_.get();
 }

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

inlineprotected

Definition at line 311 of file OutputModule.h.

References moduleDescription_.

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

 {
   return moduleDescription_;
 }

void art::OutputModule::doBeginJob ( )

private

Definition at line 123 of file OutputModule.cc.

References beginJob(), and plugins_.

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

bool art::OutputModule::doBeginRun	(	RunPrincipal const &	rp,
		CurrentProcessingContext const *	cpc
	)

private

Definition at line 130 of file OutputModule.cc.

References beginRun(), current_context_, FDEBUG, moduleDescription_, art::Consumer::non_module_context(), and plugins_.

 {
   detail::CPCSentry sentry{current_context_, cpc};
   FDEBUG(2) << "beginRun called\n";
   beginRun(rp);
   Run const r{rp, moduleDescription_, Consumer::non_module_context()};
   cet::for_all(plugins_, [&r](auto& p) { p->doBeginRun(r); });
   return true;
 }

bool art::OutputModule::doBeginSubRun	(	SubRunPrincipal const &	srp,
		CurrentProcessingContext const *	cpc
	)

private

Definition at line 142 of file OutputModule.cc.

References beginSubRun(), current_context_, FDEBUG, moduleDescription_, art::Consumer::non_module_context(), and plugins_.

 {
   detail::CPCSentry sentry{current_context_, cpc};
   FDEBUG(2) << "beginSubRun called\n";
   beginSubRun(srp);
   SubRun const sr{srp, moduleDescription_, Consumer::non_module_context()};
   cet::for_all(plugins_, [&sr](auto& p) { p->doBeginSubRun(sr); });
   return true;
 }

void art::OutputModule::doCloseFile ( )

private

Definition at line 297 of file OutputModule.cc.

References isFileOpen(), and reallyCloseFile().

Referenced by art::OutputWorker::closeFile(), and workerType().

 {
   if (isFileOpen()) {
     reallyCloseFile();
   }
 }

void art::OutputModule::doEndJob ( )

private

Definition at line 252 of file OutputModule.cc.

References endJob(), and plugins_.

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

bool art::OutputModule::doEndRun	(	RunPrincipal const &	rp,
		CurrentProcessingContext const *	cpc
	)

private

Definition at line 233 of file OutputModule.cc.

References current_context_, endRun(), FDEBUG, moduleDescription_, art::Consumer::non_module_context(), and plugins_.

 {
   detail::CPCSentry sentry{current_context_, cpc};
   FDEBUG(2) << "endRun called\n";
   endRun(rp);
   Run const r{rp, moduleDescription_, Consumer::non_module_context()};
   cet::for_all(plugins_, [&r](auto& p) { p->doEndRun(r); });
   return true;
 }

bool art::OutputModule::doEndSubRun	(	SubRunPrincipal const &	srp,
		CurrentProcessingContext const *	cpc
	)

private

Definition at line 207 of file OutputModule.cc.

References current_context_, endSubRun(), FDEBUG, moduleDescription_, art::Consumer::non_module_context(), and plugins_.

 {
   detail::CPCSentry sentry{current_context_, cpc};
   FDEBUG(2) << "endSubRun called\n";
   endSubRun(srp);
   SubRun const sr{srp, moduleDescription_, Consumer::non_module_context()};
   cet::for_all(plugins_, [&sr](auto& p) { p->doEndSubRun(sr); });
   return true;
 }

bool art::OutputModule::doEvent	(	EventPrincipal const &	ep,
		CurrentProcessingContext const *	cpc,
		CountingStatistics &	counts
	)

private

Definition at line 154 of file OutputModule.cc.

References current_context_, e, event(), FDEBUG, art::ExecutionCounts< ARGS >::increment(), moduleDescription_, art::EventObserverBase::wantAllEvents(), and art::EventObserverBase::wantEvent().

 {
   detail::CPCSentry sentry{current_context_, cpc};
   FDEBUG(2) << "doEvent called\n";
   Event const e{ep, moduleDescription_, this};
   if (wantAllEvents() || wantEvent(e)) {
     // Run is incremented before event(ep); to properly count whenever
     // an exception is thrown in the user's module.
     counts.increment<stats::Run>();
     event(ep);
     counts.increment<stats::Passed>();
   }
   return true;
 }

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

private

Definition at line 259 of file OutputModule.cc.

References openFile().

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

 {
   openFile(fb);
 }

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

protectedvirtual

Reimplemented in art::RootOutput.

Definition at line 117 of file OutputModule.cc.

Referenced by fileIsOpen(), and registerProducts().

120 {}

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

private

Definition at line 279 of file OutputModule.cc.

References respondToCloseInputFile().

 {
   respondToCloseInputFile(fb);
 }

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

private

Definition at line 291 of file OutputModule.cc.

References respondToCloseOutputFiles().

 {
   respondToCloseOutputFiles(fb);
 }

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

private

Definition at line 265 of file OutputModule.cc.

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

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

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

private

Definition at line 285 of file OutputModule.cc.

References respondToOpenOutputFiles().

 {
   respondToOpenOutputFiles(fb);
 }

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

private

Definition at line 70 of file OutputModule.cc.

References art::BranchDescription::branchType(), art::BranchDescription::dropped(), groupSelector_, groupSelectorRules_, hasNewlyDroppedBranch_, keptProducts_, selected(), and art::BranchDescription::transient().

Referenced by selectProducts().

 {
   // These variables cause problems for MT.  This function must be
   // called in a single-threaded context.
   groupSelector_ =
     std::make_unique<GroupSelector const>(groupSelectorRules_, productList);
   keptProducts_ = {{}};
 
   // 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& val : productList) {
     BranchDescription const& pd = val.second;
     auto const bt = pd.branchType();
     if (pd.transient() || pd.dropped()) {
       continue;
     }
     if (selected(pd)) {
       keptProducts_[bt].push_back(&pd);
       continue;
     }
     // Newly dropped, skip it.
     hasNewlyDroppedBranch_[bt] = true;
   }
 }

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

private

Definition at line 226 of file OutputModule.cc.

References FDEBUG, and setRunAuxiliaryRangeSetID().

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

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

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

private

Definition at line 201 of file OutputModule.cc.

References setSubRunAuxiliaryRangeSetID().

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

 {
   setSubRunAuxiliaryRangeSetID(ranges);
 }

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

private

Definition at line 172 of file OutputModule.cc.

References art::EventObserverBase::cachedProducts(), ci_, e, FDEBUG, art::EventObserverBase::getTriggerResults(), art::EventPrincipal::id(), moduleDescription_, art::ModuleDescription::moduleLabel(), art::Consumer::non_module_context(), plugins_, remainingEvents_, updateBranchParents(), art::EventObserverBase::wantAllEvents(), art::EventObserverBase::wantEvent(), and write().

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

 {
   detail::PVSentry clearTriggerResults{cachedProducts()};
   FDEBUG(2) << "writeEvent called\n";
   Event const e{ep, moduleDescription_, this};
   if (wantAllEvents() || wantEvent(e)) {
     write(ep); // Write the event.
     // Declare that the event was selected for write to the catalog
     // interface
     art::Handle<art::TriggerResults> trHandle{getTriggerResults(e)};
     auto const& trRef(trHandle.isValid() ?
                         static_cast<HLTGlobalStatus>(*trHandle) :
                         HLTGlobalStatus{});
     ci_->eventSelected(moduleDescription_.moduleLabel(), ep.id(), trRef);
     // ... and invoke the plugins:
     // ... The transactional object presented to the plugins is
     //     different since the relevant context information is not the
     //     same for the consumes functionality.
     Event const we{ep, moduleDescription_, Consumer::non_module_context()};
     cet::for_all(plugins_, [&we](auto& p) { p->doCollectMetadata(we); });
     // Finish.
     updateBranchParents(ep);
     if (remainingEvents_ > 0) {
       --remainingEvents_;
     }
   }
 }

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 535 of file OutputModule.cc.

Referenced by fileGranularity(), and writeFileCatalogMetadata().

538 {}

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

private

Definition at line 245 of file OutputModule.cc.

References FDEBUG, and writeRun().

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

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

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

private

Definition at line 219 of file OutputModule.cc.

References FDEBUG, and writeSubRun().

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

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

void art::OutputModule::endJob ( )

privatevirtual

Reimplemented in art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >, art::ProvenanceDumper< DETAIL, Enable >, and art::RootOutput.

Definition at line 365 of file OutputModule.cc.

Referenced by doEndJob(), and fileGranularity().

366 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 377 of file OutputModule.cc.

Referenced by doEndRun(), and fileGranularity().

378 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 385 of file OutputModule.cc.

Referenced by doEndSubRun(), and fileGranularity().

386 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 369 of file OutputModule.cc.

Referenced by doEvent(), and fileGranularity().

370 {}

virtual Granularity art::OutputModule::fileGranularity ( ) const

inlineprivatevirtual

Reimplemented in art::RootOutput.

Definition at line 245 of file OutputModule.h.

References beginJob(), beginRun(), beginSubRun(), doWriteFileCatalogMetadata(), e, endJob(), endRun(), endSubRun(), event(), fillDependencyGraph(), finishEndFile(), isFileOpen(), limitReached(), makePlugins_(), openFile(), readResults(), respondToCloseInputFile(), respondToCloseOutputFiles(), respondToOpenInputFile(), respondToOpenOutputFiles(), setFileStatus(), setModuleDescription(), setRunAuxiliaryRangeSetID(), setSubRunAuxiliaryRangeSetID(), startEndFile(), art::Granularity::Unset, updateBranchParents(), write(), writeBranchMapper(), writeEventHistory(), writeFileCatalogMetadata(), writeFileFormatVersion(), writeFileIdentifier(), writeFileIndex(), writeParameterSetRegistry(), writeParentageRegistry(), writeProcessConfigurationRegistry(), writeProcessHistoryRegistry(), writeProductDependencies(), writeProductDescriptionRegistry(), writeRun(), and writeSubRun().

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

   {
     return Granularity::Unset;
   }

bool art::OutputModule::fileIsOpen ( ) const

inline

Definition at line 104 of file OutputModule.h.

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

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

   {
     return isFileOpen();
   }

OutputFileStatus art::OutputModule::fileStatus ( ) const

Referenced by fileIsOpen().

void art::OutputModule::fillDependencyGraph ( )

private

Definition at line 344 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 fileGranularity(), and reallyCloseFile().

 {
   for (auto const& bp : branchParents_) {
     ProductID const child = bp.first;
     std::set<ParentageID> const& eIds = bp.second;
     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

Reimplemented in art::RootOutput.

Definition at line 549 of file OutputModule.cc.

Referenced by fileGranularity(), and reallyCloseFile().

550 {}

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

   {
     return selectors_.getOneTriggerResults(e);
   }

auto art::OutputModule::hasNewlyDroppedBranch ( ) const

inline

Definition at line 342 of file OutputModule.h.

References hasNewlyDroppedBranch_.

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

 {
   return hasNewlyDroppedBranch_;
 }

virtual void art::OutputModule::incrementInputFileNumber ( )

inlineprivatevirtual

Reimplemented in art::RootOutput.

Definition at line 227 of file OutputModule.h.

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

228 {}

bool art::OutputModule::isFileOpen ( ) const

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 421 of file OutputModule.cc.

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

 {
   return true;
 }

auto art::OutputModule::keptProducts ( ) const

inline

Definition at line 336 of file OutputModule.h.

References keptProducts_.

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

 {
   return keptProducts_;
 }

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

virtual

Reimplemented in art::RootOutput.

Definition at line 58 of file OutputModule.cc.

References configuredFileName_.

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

 {
   return configuredFileName_;
 }

bool art::OutputModule::limitReached ( ) const

inlineprivate

Definition at line 361 of file OutputModule.h.

References remainingEvents_.

Referenced by fileGranularity(), and art::OutputWorker::limitReached().

 {
   return remainingEvents_ == 0;
 }

auto art::OutputModule::makePlugins_ ( fhicl::ParameterSet const & top_pset )

private

Definition at line 553 of file OutputModule.cc.

References art::errors::Configuration, description(), e, art::ModuleDescription::moduleLabel(), pluginFactory_, pluginNames_, and fhicl::detail::atom::value().

Referenced by fileGranularity(), and OutputModule().

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

int art::OutputModule::maxEvents ( ) const

inline

Definition at line 317 of file OutputModule.h.

References 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::openFile ( FileBlock const & )

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 397 of file OutputModule.cc.

Referenced by doOpenFile(), and fileGranularity().

398 {}

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

delete

void art::OutputModule::postSelectProducts ( )

protectedvirtual

Reimplemented in art::RootOutput.

Definition at line 113 of file OutputModule.cc.

Referenced by fileIsOpen(), and 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::readResults ( ResultsPrincipal const & resp )

privatevirtual

Reimplemented in art::RootOutput, and art::FileDumperOutput.

Definition at line 405 of file OutputModule.cc.

Referenced by doRespondToOpenInputFile(), and fileGranularity().

406 {}

void art::OutputModule::reallyCloseFile ( )

private

Definition at line 305 of file OutputModule.cc.

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

Referenced by doCloseFile(), and workerType().

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

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

Definition at line 105 of file OutputModule.cc.

References doRegisterProducts().

Referenced by fileIsOpen().

 {
   doRegisterProducts(mpr, producedProducts, md);
 }

int art::OutputModule::remainingEvents ( ) const

inline

Definition at line 323 of file OutputModule.h.

References remainingEvents_.

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

 {
   return remainingEvents_;
 }

virtual bool art::OutputModule::requestsToCloseFile ( ) const

inlineprivatevirtual

Reimplemented in art::RootOutput.

Definition at line 240 of file OutputModule.h.

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

   {
     return false;
   }

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 409 of file OutputModule.cc.

Referenced by doRespondToCloseInputFile(), and fileGranularity().

410 {}

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

privatevirtual

Definition at line 417 of file OutputModule.cc.

Referenced by doRespondToCloseOutputFiles(), and fileGranularity().

418 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 401 of file OutputModule.cc.

Referenced by doRespondToOpenInputFile(), and fileGranularity().

402 {}

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

privatevirtual

Definition at line 413 of file OutputModule.cc.

Referenced by doRespondToOpenOutputFiles(), and fileGranularity().

414 {}

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

inline

Definition at line 329 of file OutputModule.h.

References groupSelector_.

Referenced by doSelectProducts(), and 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 )

Definition at line 98 of file OutputModule.cc.

References doSelectProducts(), and postSelectProducts().

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

 {
   doSelectProducts(productList);
   postSelectProducts();
 }

void art::OutputModule::setFileStatus ( OutputFileStatus )

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 427 of file OutputModule.cc.

Referenced by fileGranularity(), and art::OutputWorker::setFileStatus().

428 {}

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

inlineprivate

Definition at line 355 of file OutputModule.h.

References moduleDescription_.

Referenced by fileGranularity().

 {
   moduleDescription_ = md;
 }

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 389 of file OutputModule.cc.

Referenced by doSetRunAuxiliaryRangeSetID(), and fileGranularity().

390 {}

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

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 393 of file OutputModule.cc.

Referenced by doSetSubRunAuxiliaryRangeSetID(), and fileGranularity().

394 {}

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::OutputModule::startEndFile ( )

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 431 of file OutputModule.cc.

Referenced by fileGranularity(), and reallyCloseFile().

432 {}

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

private

Definition at line 327 of file OutputModule.cc.

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

Referenced by doWriteEvent(), and fileGranularity().

 {
   for (auto const& groupPr : ep) {
     auto const& group = *groupPr.second;
     if (group.productProvenancePtr()) {
       ProductID const pid = groupPr.first;
       auto it = branchParents_.find(pid);
       if (it == branchParents_.end()) {
         it = branchParents_.emplace(pid, std::set<ParentageID>{}).first;
       }
       it->second.insert(group.productProvenancePtr()->parentageID());
       branchChildren_.insertEmpty(pid);
     }
   }
 }

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(), doEvent(), 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(), doEvent(), and doWriteEvent().

   {
     return selectors_.wantEvent(e);
   }

std::string art::OutputModule::workerType ( ) const

inlineprivate

Definition at line 214 of file OutputModule.h.

References doCloseFile(), and reallyCloseFile().

   {
     return "OutputWorker";
   }

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

privatepure virtual

Implemented in art::ProvenanceDumper< DETAIL, cet::enable_if_type_exists_t< typename DETAIL::Config > >, art::ProvenanceDumper< DETAIL, Enable >, art::RootOutput, art::FileDumperOutput, and art::ProvenanceCheckerOutput.

Referenced by doWriteEvent(), and fileGranularity().

void art::OutputModule::writeBranchMapper ( )

privatevirtual

Definition at line 545 of file OutputModule.cc.

Referenced by fileGranularity(), and reallyCloseFile().

546 {}

void art::OutputModule::writeEventHistory ( )

privatevirtual

Reimplemented in art::RootOutput.

Definition at line 447 of file OutputModule.cc.

Referenced by fileGranularity(), and reallyCloseFile().

448 {}

void art::OutputModule::writeFileCatalogMetadata ( )

private

Definition at line 514 of file OutputModule.cc.

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

Referenced by fileGranularity(), and reallyCloseFile().

 {
   // Obtain metadata from service for output.
   FileCatalogMetadata::collection_type md, ssmd;
   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.
   collectStreamSpecificMetadata(plugins_, pluginNames_, ssmd);
   doWriteFileCatalogMetadata(md, ssmd);
 }