#include <SharedProducer.h>

Inheritance diagram for art::SharedProducer:

Public Types
using	ModuleType = SharedProducer

using	WorkerType = WorkerT< SharedProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	SharedProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	SharedProducer (Table< Config > const &config)

std::string	workerType () const

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

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

void	doBeginJob (SharedResources const &resources)

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 &rp, ModuleContext const &mc)

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

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

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

bool	doEvent (EventPrincipal &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)

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

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

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)

Private Member Functions
void	setupQueues (detail::SharedResources const &) override final

void	beginJobWithFrame (ProcessingFrame const &) override final

void	endJobWithFrame (ProcessingFrame const &) override final

void	respondToOpenInputFileWithFrame (FileBlock const &, ProcessingFrame const &) override final

void	respondToCloseInputFileWithFrame (FileBlock const &, ProcessingFrame const &) override final

void	respondToOpenOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) override final

void	respondToCloseOutputFilesWithFrame (FileBlock const &, ProcessingFrame const &) override final

void	beginRunWithFrame (Run &, ProcessingFrame const &) override final

void	endRunWithFrame (Run &, ProcessingFrame const &) override final

void	beginSubRunWithFrame (SubRun &, ProcessingFrame const &) override final

void	endSubRunWithFrame (SubRun &, ProcessingFrame const &) override final

void	produceWithFrame (Event &, ProcessingFrame const &) override final

virtual void	beginJob (ProcessingFrame const &)

virtual void	endJob (ProcessingFrame const &)

virtual void	respondToOpenInputFile (FileBlock const &, ProcessingFrame const &)

virtual void	respondToCloseInputFile (FileBlock const &, ProcessingFrame const &)

virtual void	respondToOpenOutputFiles (FileBlock const &, ProcessingFrame const &)

virtual void	respondToCloseOutputFiles (FileBlock const &, ProcessingFrame const &)

virtual void	beginRun (Run &, ProcessingFrame const &)

virtual void	endRun (Run &, ProcessingFrame const &)

virtual void	beginSubRun (SubRun &, ProcessingFrame const &)

virtual void	endSubRun (SubRun &, ProcessingFrame const &)

virtual void	produce (Event &, ProcessingFrame const &)=0

Additional Inherited Members
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 ()

Detailed Description

Definition at line 18 of file SharedProducer.h.

Member Typedef Documentation

using art::SharedProducer::ModuleType = SharedProducer

Definition at line 20 of file SharedProducer.h.

using art::SharedProducer::WorkerType = WorkerT<SharedProducer>

Definition at line 21 of file SharedProducer.h.

Constructor & Destructor Documentation

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

inlineexplicit

Definition at line 23 of file SharedProducer.h.

       : detail::Producer{pset}
       , detail::SharedModule{pset.get<std::string>("module_label", {})}
     {}

template<typename Config >

art::SharedProducer::SharedProducer ( Table< Config > const & config )

inlineexplicit

Definition at line 29 of file SharedProducer.h.

30 : SharedProducer{config.get_PSet()}

31 {}

art::SharedProducer::SharedProducer

SharedProducer(fhicl::ParameterSet const &pset)

Definition: SharedProducer.h:23

config

static Config * config

Definition: config.cpp:1054

Member Function Documentation

void art::SharedProducer::beginJob ( ProcessingFrame const & )

privatevirtual

Reimplemented in hit::GausHitFinder.

Definition at line 94 of file SharedProducer.cc.

95 {}

void art::SharedProducer::beginJobWithFrame ( ProcessingFrame const & frame )

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 51 of file SharedProducer.cc.

   {
     beginJob(frame);
   }

void art::SharedProducer::beginRun	(	Run &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 122 of file SharedProducer.cc.

123 {}

void art::SharedProducer::beginRunWithFrame	(	Run &	r,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 63 of file SharedProducer.cc.

   {
     beginRun(r, frame);
   }

void art::SharedProducer::beginSubRun	(	SubRun &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 130 of file SharedProducer.cc.

131 {}

void art::SharedProducer::beginSubRunWithFrame	(	SubRun &	sr,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 75 of file SharedProducer.cc.

   {
     beginSubRun(sr, frame);
   }

void art::SharedProducer::endJob ( ProcessingFrame const & )

privatevirtual

Definition at line 98 of file SharedProducer.cc.

99 {}

void art::SharedProducer::endJobWithFrame ( ProcessingFrame const & frame )

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 57 of file SharedProducer.cc.

   {
     endJob(frame);
   }

void art::SharedProducer::endRun	(	Run &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 126 of file SharedProducer.cc.

127 {}

void art::SharedProducer::endRunWithFrame	(	Run &	r,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 69 of file SharedProducer.cc.

   {
     endRun(r, frame);
   }

void art::SharedProducer::endSubRun	(	SubRun &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 134 of file SharedProducer.cc.

135 {}

void art::SharedProducer::endSubRunWithFrame	(	SubRun &	sr,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 81 of file SharedProducer.cc.

   {
     endSubRun(sr, frame);
   }

virtual void art::SharedProducer::produce	(	Event &	,
		ProcessingFrame const &
	)

privatepure virtual

Implemented in hit::GausHitFinder, art::RandomNumberSaver, and wcls::WireCellToolkit.

void art::SharedProducer::produceWithFrame	(	Event &	e,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 87 of file SharedProducer.cc.

   {
     produce(e, frame);
   }

void art::SharedProducer::respondToCloseInputFile	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 107 of file SharedProducer.cc.

109 {}

void art::SharedProducer::respondToCloseInputFileWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 28 of file SharedProducer.cc.

   {
     respondToCloseInputFile(fb, frame);
   }

void art::SharedProducer::respondToCloseOutputFiles	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 117 of file SharedProducer.cc.

119 {}

void art::SharedProducer::respondToCloseOutputFilesWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 43 of file SharedProducer.cc.

   {
     respondToCloseOutputFiles(fb, frame);
   }

void art::SharedProducer::respondToOpenInputFile	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 102 of file SharedProducer.cc.

104 {}

void art::SharedProducer::respondToOpenInputFileWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 21 of file SharedProducer.cc.

   {
     respondToOpenInputFile(fb, frame);
   }

void art::SharedProducer::respondToOpenOutputFiles	(	FileBlock const &	,
		ProcessingFrame const &
	)

privatevirtual

Definition at line 112 of file SharedProducer.cc.

114 {}

void art::SharedProducer::respondToOpenOutputFilesWithFrame	(	FileBlock const &	fb,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 35 of file SharedProducer.cc.

   {
     respondToOpenOutputFiles(fb, frame);
   }

void art::SharedProducer::setupQueues ( detail::SharedResources const & resources )

finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 15 of file SharedProducer.cc.

   {
     createQueues(resources);
   }

string art::SharedProducer::workerType ( ) const

Definition at line 9 of file SharedProducer.cc.

   {
     return "WorkerT<SharedProducer>";
   }

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

art/art/Framework/Core/SharedProducer.h
art/art/Framework/Core/SharedProducer.cc

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation