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

	OutputModule (fhicl::ParameterSet const &pset)

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

	OutputModule (OutputModule const &)=delete

	OutputModule (OutputModule &&)=delete

OutputModule &	operator= (OutputModule const &)=delete

OutputModule &	operator= (OutputModule &&)=delete

int	maxEvents () const

int	remainingEvents () const

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 &, ModuleDescription const &)

BranchChildren const &	branchChildren () const

Public Member Functions inherited from art::Observer
	~Observer () noexcept

	Observer (Observer const &)=delete

	Observer (Observer &&)=delete

Observer &	operator= (Observer const &)=delete

Observer &	operator= (Observer &&)=delete

void	registerProducts (ProductDescriptions &, ModuleDescription const &)

void	fillDescriptions (ModuleDescription const &)

fhicl::ParameterSetID	selectorConfig () const

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

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)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Public Member Functions inherited from art::detail::SharedModule
	SharedModule ()

	SharedModule (std::string const &moduleLabel)

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

Protected Member Functions inherited from art::Observer
std::string const &	processName () const

bool	wantAllEvents () const noexcept

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

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

	Observer (fhicl::ParameterSet const &config)

	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)

Protected Member Functions inherited from art::ModuleBase
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 ()

Protected Member Functions inherited from art::detail::SharedModule
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
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)

std::string	workerType () const

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

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

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_

int	maxEvents_ {-1}

int	remainingEvents_ {maxEvents_}

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

class	OutputWorker

Detailed Description

Definition at line 48 of file OutputModule.h.

Member Typedef Documentation

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

private

Definition at line 240 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 ( )

virtualdefaultnoexcept

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

explicit

Definition at line 73 of file OutputModule.cc.

     : 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,
		fhicl::ParameterSet const &	containing_pset
	)

explicit

Definition at line 54 of file OutputModule.cc.

     : Observer{config().eoFragment().selectEvents(),
                config().eoFragment().rejectEvents(),
                containing_pset}
     , 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

void art::OutputModule::beginJob ( )

privatevirtual

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

Definition at line 441 of file OutputModule.cc.

442 {}

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

privatevirtual

Definition at line 453 of file OutputModule.cc.

454 {}

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

privatevirtual

Definition at line 461 of file OutputModule.cc.

462 {}

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

Definition at line 694 of file OutputModule.cc.

   {
     return branchChildren_;
   }

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

private

Definition at line 122 of file OutputModule.cc.

   {
     remainingEvents_ = maxEvents_ = desc.maxEvents_;
   }

void art::OutputModule::doBeginJob ( detail::SharedResources const & resources )

privatevirtual

Definition at line 191 of file OutputModule.cc.

   {
     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 199 of file OutputModule.cc.

   {
     FDEBUG(2) << "beginRun called\n";
     beginRun(rp);
     Run const r{rp, 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 209 of file OutputModule.cc.

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

bool art::OutputModule::doCloseFile ( )

private

Definition at line 358 of file OutputModule.cc.

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

void art::OutputModule::doEndJob ( )

private

Definition at line 307 of file OutputModule.cc.

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

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

private

Definition at line 290 of file OutputModule.cc.

   {
     FDEBUG(2) << "endRun called\n";
     endRun(rp);
     Run const r{rp, 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 266 of file OutputModule.cc.

   {
     FDEBUG(2) << "endSubRun called\n";
     endSubRun(srp);
     SubRun const sr{srp, 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 220 of file OutputModule.cc.

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

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

private

Definition at line 314 of file OutputModule.cc.

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

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

protectedvirtual

Definition at line 186 of file OutputModule.cc.

188 {}

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

private

Definition at line 340 of file OutputModule.cc.

   {
     respondToCloseInputFile(fb);
   }

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

private

Definition at line 352 of file OutputModule.cc.

   {
     respondToCloseOutputFiles(fb);
   }

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

private

Definition at line 324 of file OutputModule.cc.

   {
     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 346 of file OutputModule.cc.

   {
     respondToOpenOutputFiles(fb);
   }

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

Definition at line 128 of file OutputModule.cc.

   {
     // 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& val : productList) {
         BranchDescription const& pd = val.second;
         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 283 of file OutputModule.cc.

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

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

private

Definition at line 260 of file OutputModule.cc.

   {
     setSubRunAuxiliaryRangeSetID(ranges);
   }

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

private

Definition at line 237 of file OutputModule.cc.

   {
     FDEBUG(2) << "writeEvent called\n";
     Event const e{ep, 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);
       if (remainingEvents_ > 0) {
         --remainingEvents_;
       }
     }
   }

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

privatevirtual

Definition at line 618 of file OutputModule.cc.

621 {}

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

private

Definition at line 300 of file OutputModule.cc.

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

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

private

Definition at line 276 of file OutputModule.cc.

   {
     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 445 of file OutputModule.cc.

446 {}

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

privatevirtual

Definition at line 457 of file OutputModule.cc.

458 {}

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

privatevirtual

Definition at line 465 of file OutputModule.cc.

466 {}

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

privatevirtual

Definition at line 449 of file OutputModule.cc.

450 {}

Granularity art::OutputModule::fileGranularity ( ) const

privatevirtual

Reimplemented in arttest::EventProcessorTestOutput.

Definition at line 110 of file OutputModule.cc.

   {
     return Granularity::Unset;
   }

bool art::OutputModule::fileIsOpen ( ) const

Definition at line 88 of file OutputModule.cc.

   {
     return isFileOpen();
   }

OutputFileStatus art::OutputModule::fileStatus ( ) const

void art::OutputModule::fillDependencyGraph ( )

private

Definition at line 423 of file OutputModule.cc.

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

Definition at line 628 of file OutputModule.cc.

629 {}

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

Definition at line 688 of file OutputModule.cc.

   {
     return hasNewlyDroppedBranch_;
   }

void art::OutputModule::incrementInputFileNumber ( )

privatevirtual

Reimplemented in arttest::EventProcessorTestOutput.

Definition at line 100 of file OutputModule.cc.

101 {}

bool art::OutputModule::isFileOpen ( ) const

privatevirtual

Definition at line 501 of file OutputModule.cc.

   {
     return true;
   }

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

Definition at line 674 of file OutputModule.cc.

   {
     return keptProducts_;
   }

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

virtual

Definition at line 116 of file OutputModule.cc.

   {
     return configuredFileName_;
   }

bool art::OutputModule::limitReached ( ) const

private

Definition at line 700 of file OutputModule.cc.

   {
     return remainingEvents_ == 0;
   }

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

private

Definition at line 632 of file OutputModule.cc.

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

int art::OutputModule::maxEvents ( ) const

Definition at line 662 of file OutputModule.cc.

   {
     return maxEvents_;
   }

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

privatevirtual

Definition at line 477 of file OutputModule.cc.

478 {}

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

delete

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

delete

void art::OutputModule::postSelectProducts ( )

privatevirtual

Definition at line 175 of file OutputModule.cc.

176 {}

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

privatevirtual

Reimplemented in art::FileDumperOutput.

Definition at line 485 of file OutputModule.cc.

486 {}

void art::OutputModule::reallyCloseFile ( )

private

Definition at line 368 of file OutputModule.cc.

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

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

Definition at line 179 of file OutputModule.cc.

   {
     doRegisterProducts(producedProducts, md);
   }

int art::OutputModule::remainingEvents ( ) const

Definition at line 668 of file OutputModule.cc.

   {
     return remainingEvents_;
   }

bool art::OutputModule::requestsToCloseFile ( ) const

privatevirtual

Reimplemented in arttest::EventProcessorTestOutput.

Definition at line 104 of file OutputModule.cc.

   {
     return false;
   }

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

privatevirtual

Definition at line 489 of file OutputModule.cc.

490 {}

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

privatevirtual

Definition at line 497 of file OutputModule.cc.

498 {}

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

privatevirtual

Reimplemented in arttest::EventProcessorTestOutput.

Definition at line 481 of file OutputModule.cc.

482 {}

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

privatevirtual

Definition at line 493 of file OutputModule.cc.

494 {}

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

Definition at line 680 of file OutputModule.cc.

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

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

Definition at line 168 of file OutputModule.cc.

   {
     doSelectProducts(tables);
     postSelectProducts();
   }

void art::OutputModule::setFileStatus ( OutputFileStatus )

privatevirtual

Definition at line 507 of file OutputModule.cc.

508 {}

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

privatevirtual

Definition at line 469 of file OutputModule.cc.

470 {}

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

privatevirtual

Definition at line 473 of file OutputModule.cc.

474 {}

void art::OutputModule::startEndFile ( )

privatevirtual

Definition at line 511 of file OutputModule.cc.

512 {}

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

private

Definition at line 391 of file OutputModule.cc.

   {
     // 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_and_uptr_to_grp : ep) {
       auto const& group = *pid_and_uptr_to_grp.second;
       if (group.productProvenance()) {
         ProductID const pid = pid_and_uptr_to_grp.first;
         auto iter = branchParents_.find(pid);
         if (iter == branchParents_.end()) {
           iter = branchParents_.emplace(pid, set<ParentageID>{}).first;
         }
         iter->second.insert(group.productProvenance()->parentageID());
         branchChildren_.insertEmpty(pid);
       }
     }
   }

string art::OutputModule::workerType ( ) const

private

Definition at line 94 of file OutputModule.cc.

   {
     return "OutputWorker";
   }

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

privatepure virtual

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

void art::OutputModule::writeBranchIDListRegistry ( )

privatevirtual

Definition at line 543 of file OutputModule.cc.

544 {}

void art::OutputModule::writeEventHistory ( )

privatevirtual

Definition at line 527 of file OutputModule.cc.

528 {}

void art::OutputModule::writeFileCatalogMetadata ( )

private

Definition at line 596 of file OutputModule.cc.

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

void art::OutputModule::writeFileFormatVersion ( )

privatevirtual

Definition at line 515 of file OutputModule.cc.

516 {}

void art::OutputModule::writeFileIdentifier ( )

privatevirtual

Definition at line 519 of file OutputModule.cc.

520 {}

void art::OutputModule::writeFileIndex ( )

privatevirtual

Definition at line 523 of file OutputModule.cc.

524 {}

void art::OutputModule::writeParameterSetRegistry ( )

privatevirtual

Definition at line 539 of file OutputModule.cc.

540 {}

void art::OutputModule::writeParentageRegistry ( )

privatevirtual

Definition at line 547 of file OutputModule.cc.

548 {}

void art::OutputModule::writeProcessConfigurationRegistry ( )

privatevirtual

Definition at line 531 of file OutputModule.cc.

532 {}

void art::OutputModule::writeProcessHistoryRegistry ( )

privatevirtual

Definition at line 535 of file OutputModule.cc.

536 {}

void art::OutputModule::writeProductDependencies ( )

privatevirtual

Definition at line 624 of file OutputModule.cc.

625 {}

void art::OutputModule::writeProductDescriptionRegistry ( )

privatevirtual

Definition at line 551 of file OutputModule.cc.

552 {}

virtual void art::OutputModule::writeRun ( RunPrincipal & r )

privatepure virtual

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

virtual void art::OutputModule::writeSubRun ( SubRunPrincipal & sr )

privatepure virtual

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

Friends And Related Function Documentation

friend class OutputWorker

friend

Definition at line 50 of file OutputModule.h.

friend class WorkerT< OutputModule >

friend

Definition at line 49 of file OutputModule.h.

Member Data Documentation

BranchChildren art::OutputModule::branchChildren_ {}

private

Definition at line 242 of file OutputModule.h.

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

private

Definition at line 241 of file OutputModule.h.

ServiceHandle<CatalogInterface> art::OutputModule::ci_ {}

private

Definition at line 246 of file OutputModule.h.

std::string art::OutputModule::configuredFileName_

private

Definition at line 243 of file OutputModule.h.

std::string art::OutputModule::dataTier_

private

Definition at line 244 of file OutputModule.h.

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

private

Definition at line 235 of file OutputModule.h.

GroupSelectorRules art::OutputModule::groupSelectorRules_

private

Definition at line 237 of file OutputModule.h.

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

private

Definition at line 236 of file OutputModule.h.

SelectionsArray art::OutputModule::keptProducts_ {{}}

private

Definition at line 233 of file OutputModule.h.

int art::OutputModule::maxEvents_ {-1}

private

Definition at line 238 of file OutputModule.h.

cet::BasicPluginFactory art::OutputModule::pluginFactory_ {}

private

Definition at line 247 of file OutputModule.h.

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

private

Definition at line 250 of file OutputModule.h.

PluginCollection_t art::OutputModule::plugins_

private

Definition at line 251 of file OutputModule.h.

int art::OutputModule::remainingEvents_ {maxEvents_}

private

Definition at line 239 of file OutputModule.h.

std::string art::OutputModule::streamName_

private

Definition at line 245 of file OutputModule.h.

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

art/art/Framework/Core/OutputModule.h
art/art/Framework/Core/OutputModule.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation