Inheritance diagram for art::RootOutput:

Classes
struct	Config

Public Types
using	Parameters = fhicl::WrappedTable< Config, Config::KeysToIgnore >

using	ModuleType = OutputModule

using	WorkerType = OutputWorker

Public Member Functions
	RootOutput (Parameters const &)

void	postSelectProducts () override

void	beginJob () override

void	endJob () override

void	event (EventPrincipal const &) override

void	beginSubRun (SubRunPrincipal const &) override

void	endSubRun (SubRunPrincipal const &) override

void	beginRun (RunPrincipal const &) override

void	endRun (RunPrincipal const &) override

int	maxEvents () const

int	remainingEvents () const

bool	fileIsOpen () const

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

Static Public Attributes
static constexpr char const *	default_tmpDir {"<parent-path-of-filename>"}

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

ModuleDescription const &	description () const

detail::CachedProducts &	cachedProducts ()

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

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Member Functions
std::string	fileNameAtOpen () const

std::string	fileNameAtClose (std::string const &currentFileName)

std::string const &	lastClosedFileName () const override

void	openFile (FileBlock const &) override

void	respondToOpenInputFile (FileBlock const &) override

void	readResults (ResultsPrincipal const &resp) override

void	respondToCloseInputFile (FileBlock const &) override

void	incrementInputFileNumber () override

Granularity	fileGranularity () const override

void	write (EventPrincipal &) override

void	writeSubRun (SubRunPrincipal &) override

void	writeRun (RunPrincipal &) override

void	setSubRunAuxiliaryRangeSetID (RangeSet const &) override

void	setRunAuxiliaryRangeSetID (RangeSet const &) override

bool	isFileOpen () const override

void	setFileStatus (OutputFileStatus) override

bool	requestsToCloseFile () const override

void	doOpenFile ()

void	startEndFile () override

void	writeFileFormatVersion () override

void	writeFileIndex () override

void	writeEventHistory () override

void	writeProcessConfigurationRegistry () override

void	writeProcessHistoryRegistry () override

void	writeParameterSetRegistry () override

void	writeProductDescriptionRegistry () override

void	writeParentageRegistry () override

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

void	writeProductDependencies () override

void	finishEndFile () override

void	doRegisterProducts (MasterProductRegistry &mpr, ProductDescriptions &producedProducts, ModuleDescription const &md) override

Private Attributes
std::string const	catalog_

bool	dropAllEvents_ {false}

bool	dropAllSubRuns_

std::string const	moduleLabel_

int	inputFileCount_ {0}

std::unique_ptr< RootOutputFile >	rootOutputFile_ {nullptr}

FileStatsCollector	fstats_

PostCloseFileRenamer	fRenamer_ {fstats_}

std::string const	filePattern_

std::string	tmpDir_

std::string	lastClosedFileName_ {}

int const	compressionLevel_

int64_t const	saveMemoryObjectThreshold_

int64_t const	treeMaxVirtualSize_

int const	splitLevel_

int const	basketSize_

DropMetaData	dropMetaData_

bool	dropMetaDataForDroppedData_

bool	fastCloningEnabled_ {true}

bool	writeParameterSets_

ClosingCriteria	fileProperties_

ProductTable	producedResultsProducts_ {}

RPManager	rpm_

Detailed Description

Definition at line 52 of file RootOutput_module.cc.

Member Typedef Documentation

using art::OutputModule::ModuleType = OutputModule

inherited

Definition at line 61 of file OutputModule.h.

using art::RootOutput::Parameters = fhicl::WrappedTable<Config, Config::KeysToIgnore>

Definition at line 109 of file RootOutput_module.cc.

using art::OutputModule::WorkerType = OutputWorker

inherited

Definition at line 62 of file OutputModule.h.

Constructor & Destructor Documentation

art::RootOutput::RootOutput ( Parameters const & config )

explicit

Definition at line 200 of file RootOutput_module.cc.

References basketSize_, catalog_, compressionLevel_, default_tmpDir, dropAllEvents_, dropAllSubRuns_, dropMetaData_, dropMetaDataForDroppedData_, fastCloningEnabled_, filePattern_, fileProperties_, fstats_, fhicl::WrappedTable< T, KeysToIgnore >::get_PSet(), moduleLabel_, art::parent_path(), art::EventObserverBase::processName(), rpm_, saveMemoryObjectThreshold_, art::detail::shouldDropEvents(), art::detail::shouldFastClone(), splitLevel_, tmpDir_, treeMaxVirtualSize_, art::detail::validateFileNamePattern(), art::EventObserverBase::wantAllEvents(), and writeParameterSets_.

   : OutputModule{config().omConfig, config.get_PSet()}
   , catalog_{config().catalog()}
   , dropAllSubRuns_{config().dropAllSubRuns()}
   , moduleLabel_{config.get_PSet().get<string>("module_label")}
   , fstats_{moduleLabel_, processName()}
   , filePattern_{config().omConfig().fileName()}
   , tmpDir_{config().tmpDir() == default_tmpDir ? parent_path(filePattern_) :
                                                   config().tmpDir()}
   , compressionLevel_{config().compressionLevel()}
   , saveMemoryObjectThreshold_{config().saveMemoryObjectThreshold()}
   , treeMaxVirtualSize_{config().treeMaxVirtualSize()}
   , splitLevel_{config().splitLevel()}
   , basketSize_{config().basketSize()}
   , dropMetaData_{config().dropMetaData()}
   , dropMetaDataForDroppedData_{config().dropMetaDataForDroppedData()}
   , writeParameterSets_{config().writeParameterSets()}
   , fileProperties_{(
       detail::validateFileNamePattern(
         config.get_PSet().has_key(config().fileProperties.name()),
         filePattern_), // comma operator!
       config().fileProperties())}
   , rpm_{config.get_PSet()}
 {
   bool const dropAllEventsSet{config().dropAllEvents(dropAllEvents_)};
   dropAllEvents_ =
     detail::shouldDropEvents(dropAllEventsSet, dropAllEvents_, dropAllSubRuns_);
 
   // N.B. Any time file switching is enabled at a boundary other than
   //      InputFile, fastCloningEnabled_ ***MUST*** be deactivated.  This is
   //      to ensure that the Event tree from the InputFile is not
   //      accidentally cloned to the output file before the output
   //      module has seen the events that are going to be processed.
   bool const fastCloningSet{config().fastCloning(fastCloningEnabled_)};
   fastCloningEnabled_ = detail::shouldFastClone(
     fastCloningSet, fastCloningEnabled_, wantAllEvents(), fileProperties_);
 
   if (!writeParameterSets_) {
     mf::LogWarning("PROVENANCE")
       << "Output module " << moduleLabel_
       << " has parameter writeParameterSets set to false.\n"
       << "Parameter set provenance will not be available in subsequent jobs.\n"
       << "Check your experiment's policy on this issue to avoid future "
          "problems\n"
       << "with analysis reproducibility.\n";
   }
 }

Member Function Documentation

void art::RootOutput::beginJob ( )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 554 of file RootOutput_module.cc.

References art::ResultsProducer::doBeginJob(), art::RPManager::invoke(), and rpm_.

 {
   rpm_.invoke(&ResultsProducer::doBeginJob);
 }

void art::RootOutput::beginRun ( art::RunPrincipal const & rp )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 588 of file RootOutput_module.cc.

References art::ResultsProducer::doBeginRun(), art::RPManager::for_each_RPWorker(), art::RPWorker::rp(), rpm_, and w.

 {
   rpm_.for_each_RPWorker([&rp](RPWorker& w) { w.rp().doBeginRun(rp); });
 }

void art::RootOutput::beginSubRun ( art::SubRunPrincipal const & srp )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 573 of file RootOutput_module.cc.

References art::ResultsProducer::doBeginSubRun(), art::RPManager::for_each_RPWorker(), art::RPWorker::moduleDescription(), art::Consumer::non_module_context(), art::RPWorker::rp(), rpm_, and w.

 {
   rpm_.for_each_RPWorker([&srp](RPWorker& w) {
     SubRun const sr{srp, w.moduleDescription(), Consumer::non_module_context()};
     w.rp().doBeginSubRun(srp);
   });
 }

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

inlineinherited

Definition at line 349 of file OutputModule.h.

References art::OutputModule::branchChildren_.

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

 {
   return branchChildren_;
 }

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

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

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

   {
     return selectors_;
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

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

inherited

Definition at line 147 of file Consumer.h.

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

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

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

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

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

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

inherited

Definition at line 172 of file Consumer.h.

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

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

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

inlineprotectedinherited

Definition at line 305 of file OutputModule.h.

References art::OutputModule::current_context_.

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

 {
   return current_context_.get();
 }

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

inlineprotectedinherited

Definition at line 311 of file OutputModule.h.

References art::OutputModule::moduleDescription_.

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

 {
   return moduleDescription_;
 }

void art::RootOutput::doOpenFile ( )

private

Definition at line 505 of file RootOutput_module.cc.

References basketSize_, compressionLevel_, dropMetaData_, dropMetaDataForDroppedData_, fastCloningEnabled_, fileNameAtOpen(), filePattern_, fileProperties_, fstats_, inputFileCount_, art::detail::logFileAction(), art::errors::LogicError, art::FileStatsCollector::recordFileOpen(), rootOutputFile_, saveMemoryObjectThreshold_, splitLevel_, and treeMaxVirtualSize_.

Referenced by openFile().

 {
   if (inputFileCount_ == 0) {
     throw art::Exception(art::errors::LogicError)
       << "Attempt to open output file before input file. "
       << "Please report this to the core framework developers.\n";
   }
   rootOutputFile_ =
     std::make_unique<RootOutputFile>(this,
                                      fileNameAtOpen(),
                                      fileProperties_,
                                      compressionLevel_,
                                      saveMemoryObjectThreshold_,
                                      treeMaxVirtualSize_,
                                      splitLevel_,
                                      basketSize_,
                                      dropMetaData_,
                                      dropMetaDataForDroppedData_,
                                      fastCloningEnabled_);
   fstats_.recordFileOpen();
   detail::logFileAction("Opened output file with pattern ", filePattern_);
 }

void art::RootOutput::doRegisterProducts	(	MasterProductRegistry &	mpr,
		ProductDescriptions &	producedProducts,
		ModuleDescription const &	md
	)

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 450 of file RootOutput_module.cc.

References art::RPManager::for_each_RPWorker(), art::InResults, art::ModuleDescription::invalidID(), art::RPWorker::moduleDescription(), art::ModuleDescription::moduleLabel(), art::RPWorker::params(), art::ModuleDescription::processConfiguration(), producedResultsProducts_, art::ResultsProducer::registerProducts(), art::RPWorker::rp(), rpm_, art::RPWorker::setModuleDescription(), and w.

 {
   // Register Results products from ResultsProducers.
   rpm_.for_each_RPWorker([&mpr, &producedProducts, &md](RPWorker& w) {
     auto const& params = w.params();
     w.setModuleDescription(
       ModuleDescription{params.rpPSetID,
                         params.rpPluginType,
                         md.moduleLabel() + '#' + params.rpLabel,
                         md.processConfiguration(),
                         ModuleDescription::invalidID()});
     w.rp().registerProducts(mpr, producedProducts, w.moduleDescription());
   });
 
   // Form product table for Results products.  We do this here so we
   // can appropriately set the product tables for the
   // ResultsPrincipal.
   producedResultsProducts_ = ProductTable{producedProducts, InResults};
 }

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

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 424 of file RootOutput_module.cc.

References fstats_, and rootOutputFile_.

 {
   rootOutputFile_->writeFileCatalogMetadata(fstats_, md, ssmd);
 }

void art::RootOutput::endJob ( )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 560 of file RootOutput_module.cc.

References art::ResultsProducer::doEndJob(), art::RPManager::invoke(), rpm_, and art::Consumer::showMissingConsumes().

 {
   rpm_.invoke(&ResultsProducer::doEndJob);
   showMissingConsumes();
 }

void art::RootOutput::endRun ( art::RunPrincipal const & rp )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 594 of file RootOutput_module.cc.

References DEFINE_ART_MODULE, art::ResultsProducer::doEndRun(), art::RPManager::for_each_RPWorker(), art::RPWorker::rp(), rpm_, and w.

 {
   rpm_.for_each_RPWorker([&rp](RPWorker& w) { w.rp().doEndRun(rp); });
 }

void art::RootOutput::endSubRun ( art::SubRunPrincipal const & srp )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 582 of file RootOutput_module.cc.

References art::ResultsProducer::doEndSubRun(), art::RPManager::for_each_RPWorker(), art::RPWorker::rp(), rpm_, and w.

 {
   rpm_.for_each_RPWorker([&srp](RPWorker& w) { w.rp().doEndSubRun(srp); });
 }

void art::RootOutput::event ( EventPrincipal const & ep )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 567 of file RootOutput_module.cc.

References art::ResultsProducer::doEvent(), art::RPManager::for_each_RPWorker(), art::RPWorker::rp(), rpm_, and w.

 {
   rpm_.for_each_RPWorker([&ep](RPWorker& w) { w.rp().doEvent(ep); });
 }

art::Granularity art::RootOutput::fileGranularity ( ) const

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 499 of file RootOutput_module.cc.

References fileProperties_, and art::ClosingCriteria::granularity().

 {
   return fileProperties_.granularity();
 }

bool art::OutputModule::fileIsOpen ( ) const

inlineinherited

Definition at line 104 of file OutputModule.h.

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

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

   {
     return isFileOpen();
   }

string art::RootOutput::fileNameAtClose ( std::string const & currentFileName )

private

Definition at line 536 of file RootOutput_module.cc.

References filePattern_, fRenamer_, and art::PostCloseFileRenamer::maybeRenameFile().

Referenced by finishEndFile().

 {
   return filePattern_ == dev_null ?
            dev_null :
            fRenamer_.maybeRenameFile(currentFileName, filePattern_);
 }

string art::RootOutput::fileNameAtOpen ( ) const

private

Definition at line 529 of file RootOutput_module.cc.

References filePattern_, tmpDir_, and art::unique_filename().

Referenced by doOpenFile().

 {
   return filePattern_ == dev_null ? dev_null :
                                     unique_filename(tmpDir_ + "/RootOutput");
 }

OutputFileStatus art::OutputModule::fileStatus ( ) const

inherited

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

void art::RootOutput::finishEndFile ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 438 of file RootOutput_module.cc.

References art::ResultsProducer::doClear(), fileNameAtClose(), fstats_, art::RPManager::invoke(), lastClosedFileName_, art::detail::logFileAction(), art::FileStatsCollector::recordFileClose(), rootOutputFile_, and rpm_.

 {
   std::string const currentFileName{rootOutputFile_->currentFileName()};
   rootOutputFile_->writeTTrees();
   rootOutputFile_.reset();
   fstats_.recordFileClose();
   lastClosedFileName_ = fileNameAtClose(currentFileName);
   detail::logFileAction("Closed output file ", lastClosedFileName_);
   rpm_.invoke(&ResultsProducer::doClear);
 }

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

inlineinherited

Definition at line 61 of file EventObserverBase.h.

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

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

   {
     return selectors_.getOneTriggerResults(e);
   }

auto art::OutputModule::hasNewlyDroppedBranch ( ) const

inlineinherited

Definition at line 342 of file OutputModule.h.

References art::OutputModule::hasNewlyDroppedBranch_.

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

 {
   return hasNewlyDroppedBranch_;
 }

void art::RootOutput::incrementInputFileNumber ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 486 of file RootOutput_module.cc.

References isFileOpen(), and rootOutputFile_.

 {
   if (isFileOpen())
     rootOutputFile_->incrementInputFileNumber();
 }

bool art::RootOutput::isFileOpen ( ) const

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 480 of file RootOutput_module.cc.

References rootOutputFile_.

Referenced by incrementInputFileNumber(), openFile(), postSelectProducts(), requestsToCloseFile(), respondToCloseInputFile(), respondToOpenInputFile(), and setFileStatus().

 {
   return rootOutputFile_.get() != nullptr;
 }

auto art::OutputModule::keptProducts ( ) const

inlineinherited

Definition at line 336 of file OutputModule.h.

References art::OutputModule::keptProducts_.

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

 {
   return keptProducts_;
 }

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

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 544 of file RootOutput_module.cc.

References lastClosedFileName_, and art::errors::LogicError.

 {
   if (lastClosedFileName_.empty()) {
     throw Exception(errors::LogicError, "RootOutput::currentFileName(): ")
       << "called before meaningful.\n";
   }
   return lastClosedFileName_;
 }

int art::OutputModule::maxEvents ( ) const

inlineinherited

Definition at line 317 of file OutputModule.h.

References art::OutputModule::maxEvents_.

 {
   return maxEvents_;
 }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

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

inherited

Definition at line 190 of file Consumer.h.

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

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

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

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

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

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

inherited

Definition at line 215 of file Consumer.h.

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

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

bool art::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

   {
     return false;
   }

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

staticinherited

Definition at line 76 of file Consumer.cc.

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

void art::RootOutput::openFile ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 249 of file RootOutput_module.cc.

References doOpenFile(), isFileOpen(), and respondToOpenInputFile().

 {
   // Note: The file block here refers to the currently open input
   //       file, so we can find out about the available products by
   //       looping over the branches of the input file data trees.
   if (!isFileOpen()) {
     doOpenFile();
     respondToOpenInputFile(fb);
   }
 }

void art::RootOutput::postSelectProducts ( )

overridevirtual

Reimplemented from art::OutputModule.

Definition at line 261 of file RootOutput_module.cc.

References isFileOpen(), and rootOutputFile_.

 {
   if (isFileOpen()) {
     rootOutputFile_->selectProducts();
   }
 }

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

   {
     return process_name_;
   }

void art::RootOutput::readResults ( ResultsPrincipal const & resp )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 297 of file RootOutput_module.cc.

References art::ResultsProducer::doReadResults(), art::RPManager::for_each_RPWorker(), art::RPWorker::rp(), rpm_, and w.

 {
   rpm_.for_each_RPWorker([&resp](RPWorker& w) { w.rp().doReadResults(resp); });
 }

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

inherited

Definition at line 105 of file OutputModule.cc.

References art::OutputModule::doRegisterProducts().

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

 {
   doRegisterProducts(mpr, producedProducts, md);
 }

int art::OutputModule::remainingEvents ( ) const

inlineinherited

Definition at line 323 of file OutputModule.h.

References art::OutputModule::remainingEvents_.

Referenced by respondToOpenInputFile().

 {
   return remainingEvents_;
 }

bool art::RootOutput::requestsToCloseFile ( ) const

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 493 of file RootOutput_module.cc.

References isFileOpen(), and rootOutputFile_.

 {
   return isFileOpen() ? rootOutputFile_->requestsToCloseFile() : false;
 }

void art::RootOutput::respondToCloseInputFile ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 303 of file RootOutput_module.cc.

References isFileOpen(), and rootOutputFile_.

 {
   if (isFileOpen()) {
     rootOutputFile_->respondToCloseInputFile(fb);
   }
 }

void art::RootOutput::respondToOpenInputFile ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 269 of file RootOutput_module.cc.

References fastCloningEnabled_, fb(), art::FileBlock::fileName(), fstats_, inputFileCount_, isFileOpen(), art::FileStatsCollector::recordInputFile(), art::OutputModule::remainingEvents(), and rootOutputFile_.

Referenced by openFile().

 {
   ++inputFileCount_;
   if (!isFileOpen())
     return;
 
   auto const* rfb = dynamic_cast<RootFileBlock const*>(&fb);
 
   bool fastCloneThisOne = fastCloningEnabled_ && rfb &&
                           (rfb->tree() != nullptr) &&
                           ((remainingEvents() < 0) ||
                            (remainingEvents() >= rfb->tree()->GetEntries()));
   if (fastCloningEnabled_ && !fastCloneThisOne) {
     mf::LogWarning("FastCloning")
       << "Fast cloning deactivated for this input file due to "
       << "empty event tree and/or event limits.";
   }
   if (fastCloneThisOne && !rfb->fastClonable()) {
     mf::LogWarning("FastCloning")
       << "Fast cloning deactivated for this input file due to "
       << "information in FileBlock.";
     fastCloneThisOne = false;
   }
   rootOutputFile_->beginInputFile(rfb, fastCloneThisOne);
   fstats_.recordInputFile(fb.fileName());
 }

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

inlineinherited

Definition at line 329 of file OutputModule.h.

References art::OutputModule::groupSelector_.

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

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

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

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

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

   {
     return selector_config_id_;
   }

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

inherited

Definition at line 98 of file OutputModule.cc.

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

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

 {
   doSelectProducts(productList);
   postSelectProducts();
 }

void art::RootOutput::setFileStatus ( OutputFileStatus ofs )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 473 of file RootOutput_module.cc.

References isFileOpen(), and rootOutputFile_.

 {
   if (isFileOpen())
     rootOutputFile_->setFileStatus(ofs);
 }

void art::RootOutput::setRunAuxiliaryRangeSetID ( RangeSet const & rs )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 343 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->setRunAuxiliaryRangeSetID(rs);
 }

void art::RootOutput::setSubRunAuxiliaryRangeSetID ( RangeSet const & rs )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 324 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->setSubRunAuxiliaryRangeSetID(rs);
 }

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

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 359 of file RootOutput_module.cc.

References art::OutputModule::description(), art::ResultsProducer::doWriteResults(), art::RPManager::for_each_RPWorker(), art::OutputModule::hasNewlyDroppedBranch(), art::InResults, art::ProductMetaData::instance(), art::ModuleDescription::processConfiguration(), producedResultsProducts_, rootOutputFile_, art::RPWorker::rp(), rpm_, and w.

 {
   auto resp = std::make_unique<ResultsPrincipal>(
     ResultsAuxiliary{}, description().processConfiguration(), nullptr);
   resp->setProducedProducts(producedResultsProducts_);
   if (ProductMetaData::instance().productProduced(InResults) ||
       hasNewlyDroppedBranch()[InResults]) {
     resp->addToProcessHistory();
   }
   rpm_.for_each_RPWorker(
     [&resp](RPWorker& w) { w.rp().doWriteResults(*resp); });
   rootOutputFile_->writeResults(*resp);
 }

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

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

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

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

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

   {
     return wantAllEvents_;
   }

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

inlineinherited

Definition at line 51 of file EventObserverBase.h.

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

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

   {
     return selectors_.wantEvent(e);
   }

void art::RootOutput::write ( EventPrincipal & ep )

overrideprivatevirtual

Implements art::OutputModule.

Definition at line 311 of file RootOutput_module.cc.

References art::Principal::addToProcessHistory(), dropAllEvents_, fstats_, art::OutputModule::hasNewlyDroppedBranch(), art::EventPrincipal::id(), art::InEvent, art::FileStatsCollector::recordEvent(), and rootOutputFile_.

 {
   if (dropAllEvents_) {
     return;
   }
   if (hasNewlyDroppedBranch()[InEvent]) {
     ep.addToProcessHistory();
   }
   rootOutputFile_->writeOne(ep);
   fstats_.recordEvent(ep.id());
 }

void art::RootOutput::writeEventHistory ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 386 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeEventHistory();
 }

void art::RootOutput::writeFileFormatVersion ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 374 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeFileFormatVersion();
 }

void art::RootOutput::writeFileIndex ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 380 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeFileIndex();
 }

void art::RootOutput::writeParameterSetRegistry ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 404 of file RootOutput_module.cc.

References rootOutputFile_, and writeParameterSets_.

 {
   if (writeParameterSets_) {
     rootOutputFile_->writeParameterSetRegistry();
   }
 }

void art::RootOutput::writeParentageRegistry ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 418 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeParentageRegistry();
 }

void art::RootOutput::writeProcessConfigurationRegistry ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 392 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeProcessConfigurationRegistry();
 }

void art::RootOutput::writeProcessHistoryRegistry ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 398 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeProcessHistoryRegistry();
 }

void art::RootOutput::writeProductDependencies ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 432 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeProductDependencies();
 }

void art::RootOutput::writeProductDescriptionRegistry ( )

overrideprivatevirtual

Reimplemented from art::OutputModule.

Definition at line 412 of file RootOutput_module.cc.

References rootOutputFile_.

 {
   rootOutputFile_->writeProductDescriptionRegistry();
 }

void art::RootOutput::writeRun ( RunPrincipal & r )

overrideprivatevirtual

Implements art::OutputModule.

Definition at line 349 of file RootOutput_module.cc.

References art::Principal::addToProcessHistory(), fstats_, art::OutputModule::hasNewlyDroppedBranch(), art::RunPrincipal::id(), art::InRun, art::FileStatsCollector::recordRun(), and rootOutputFile_.

 {
   if (hasNewlyDroppedBranch()[InRun]) {
     r.addToProcessHistory();
   }
   rootOutputFile_->writeRun(r);
   fstats_.recordRun(r.id());
 }

void art::RootOutput::writeSubRun ( SubRunPrincipal & sr )

overrideprivatevirtual

Implements art::OutputModule.

Definition at line 330 of file RootOutput_module.cc.

References art::Principal::addToProcessHistory(), dropAllSubRuns_, fstats_, art::OutputModule::hasNewlyDroppedBranch(), art::SubRunPrincipal::id(), art::InSubRun, art::FileStatsCollector::recordSubRun(), and rootOutputFile_.

 {
   if (dropAllSubRuns_) {
     return;
   }
   if (hasNewlyDroppedBranch()[InSubRun]) {
     sr.addToProcessHistory();
   }
   rootOutputFile_->writeSubRun(sr);
   fstats_.recordSubRun(sr.id());
 }