#include <ResultsProducer.h>

Inheritance diagram for art::ResultsProducer:

Public Types
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::PluginConfig, KeysToIgnore >

Public Member Functions
virtual	~ResultsProducer () noexcept=default

	ResultsProducer () noexcept(false)

void	doBeginJob ()

void	doEndJob ()

void	doBeginRun (RunPrincipal const &)

void	doEndRun (RunPrincipal const &)

void	doBeginSubRun (SubRunPrincipal const &)

void	doEndSubRun (SubRunPrincipal const &)

void	doEvent (EventPrincipal const &)

void	doReadResults (ResultsPrincipal const &)

void	doWriteResults (ResultsPrincipal &)

void	doClear ()

void	registerProducts (ProductDescriptions &producedProducts, ModuleDescription const &md)

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)

Protected Member Functions
template<class P >
void	produces (std::string const &instanceName={})

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

Private Member Functions
virtual void	readResults (Results const &)

virtual void	writeResults (Results &)=0

virtual void	clear ()=0

virtual void	beginJob ()

virtual void	endJob ()

virtual void	beginRun (Run const &)

virtual void	endRun (Run const &)

virtual void	beginSubRun (SubRun const &)

virtual void	endSubRun (SubRun const &)

virtual void	event (Event const &)

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

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

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

template<BranchType BT = InEvent>
void	async ()

Private Member Functions inherited from art::ProductRegistryHelper
	ProductRegistryHelper (product_creation_mode)

	~ProductRegistryHelper ()

	ProductRegistryHelper (ProductRegistryHelper const &)=delete

	ProductRegistryHelper (ProductRegistryHelper &&)=delete

ProductRegistryHelper &	operator= (ProductRegistryHelper const &)=delete

ProductRegistryHelper &	operator= (ProductRegistryHelper &&)=delete

void	productList (std::unique_ptr< ProductList > p)

void	registerProducts (ProductDescriptions &productsToRegister, ModuleDescription const &md)

void	fillDescriptions (ModuleDescription const &md)

template<typename P , BranchType B>
TypeLabel const &	reconstitutes (std::string const &modLabel, std::string const &instanceName={})

template<BranchType B>
TypeLabelLookup_t const &	expectedProducts () const

template<typename P , BranchType B = InEvent>
void	produces (std::string const &instanceName={}, Persistable const persistable=Persistable::Yes)

ProducesCollector &	producesCollector () noexcept

Detailed Description

Definition at line 93 of file ResultsProducer.h.

Member Typedef Documentation

template<typename UserConfig , typename KeysToIgnore = void>

using art::ResultsProducer::Table = ProducerTable<UserConfig, detail::PluginConfig, KeysToIgnore>

Definition at line 102 of file ResultsProducer.h.

Constructor & Destructor Documentation

virtual art::ResultsProducer::~ResultsProducer ( )

virtualdefaultnoexcept

art::ResultsProducer::ResultsProducer ( )

noexcept

Definition at line 23 of file ResultsProducer.cc.

     : ProductRegistryHelper{product_creation_mode::produces}
   {
     serialize(detail::LegacyResource);
   }

Member Function Documentation

void art::ResultsProducer::beginJob ( )

privatevirtual

Definition at line 120 of file ResultsProducer.cc.

121 {}

void art::ResultsProducer::beginRun ( Run const & )

privatevirtual

Definition at line 128 of file ResultsProducer.cc.

129 {}

void art::ResultsProducer::beginSubRun ( SubRun const & )

privatevirtual

Definition at line 136 of file ResultsProducer.cc.

137 {}

virtual void art::ResultsProducer::clear ( )

privatepure virtual

Implemented in art::test::DummyResultsProducer.

void art::ResultsProducer::doBeginJob ( )

Definition at line 38 of file ResultsProducer.cc.

   {
     // If results producers ever become eligible for multi-threaded
     // execution, the serial task queues will need to be setup here.
     beginJob();
   }

void art::ResultsProducer::doBeginRun ( RunPrincipal const & rp )

Definition at line 52 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     Run const r{rp, mc};
     beginRun(r);
   }

void art::ResultsProducer::doBeginSubRun ( SubRunPrincipal const & srp )

Definition at line 68 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     SubRun const sr{srp, mc};
     beginSubRun(sr);
   }

void art::ResultsProducer::doClear ( )

Definition at line 109 of file ResultsProducer.cc.

   {
     clear();
   }

void art::ResultsProducer::doEndJob ( )

Definition at line 46 of file ResultsProducer.cc.

   {
     endJob();
   }

void art::ResultsProducer::doEndRun ( RunPrincipal const & rp )

Definition at line 60 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     Run const r{rp, mc};
     endRun(r);
   }

void art::ResultsProducer::doEndSubRun ( SubRunPrincipal const & srp )

Definition at line 76 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     SubRun const sr{srp, mc};
     endSubRun(sr);
   }

void art::ResultsProducer::doEvent ( EventPrincipal const & ep )

Definition at line 84 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     Event const e{ep, mc};
     event(e);
   }

void art::ResultsProducer::doReadResults ( ResultsPrincipal const & resp )

Definition at line 92 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     Results const res{resp, mc};
     readResults(res);
   }

void art::ResultsProducer::doWriteResults ( ResultsPrincipal & resp )

Definition at line 100 of file ResultsProducer.cc.

   {
     ModuleContext const mc{moduleDescription()};
     Results res{resp, mc};
     writeResults(res);
     res.movePutProductsToPrincipal(resp);
   }

void art::ResultsProducer::endJob ( )

privatevirtual

Definition at line 124 of file ResultsProducer.cc.

125 {}

void art::ResultsProducer::endRun ( Run const & )

privatevirtual

Definition at line 132 of file ResultsProducer.cc.

133 {}

void art::ResultsProducer::endSubRun ( SubRun const & )

privatevirtual

Definition at line 140 of file ResultsProducer.cc.

141 {}

void art::ResultsProducer::event ( Event const & )

privatevirtual

Definition at line 144 of file ResultsProducer.cc.

145 {}

template<class P >

void art::ResultsProducer::produces ( std::string const & instanceName = {} )

inlineprotected

Definition at line 148 of file ResultsProducer.h.

 {
   ProductRegistryHelper::produces<P, InResults>(instanceName);
 }

void art::ResultsProducer::readResults ( Results const & )

privatevirtual

Definition at line 116 of file ResultsProducer.cc.

117 {}

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

Definition at line 30 of file ResultsProducer.cc.

   {
     ProductRegistryHelper::registerProducts(productsToProduce, md);
     setModuleDescription(md);
   }

virtual void art::ResultsProducer::writeResults ( Results & )

privatepure virtual

Implemented in art::test::DummyResultsProducer.

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

art/art/Framework/Core/ResultsProducer.h
art/art/Framework/Core/ResultsProducer.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation