#include <ReplicatedFilter.h>

Inheritance diagram for art::ReplicatedFilter:

Public Types
using	ModuleType = ReplicatedFilter

using	WorkerType = WorkerT< ReplicatedFilter >

Public Types inherited from art::detail::Filter
template<typename UserConfig >
using	Table = Modifier::Table< UserConfig >

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

Public Member Functions
std::string	workerType () const

	ReplicatedFilter (fhicl::ParameterSet const &pset, ProcessingFrame const &frame)

template<typename Config >
	ReplicatedFilter (Table< Config > const &config, ProcessingFrame const &frame)

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

	Filter (fhicl::ParameterSet const &)

	Filter (Filter const &)=delete

	Filter (Filter &&)=delete

Filter &	operator= (Filter const &)=delete

Filter &	operator= (Filter &&)=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 &)

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)

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

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

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

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

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

bool	filterWithFrame (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 const &, ProcessingFrame const &)

virtual void	endRun (Run const &, ProcessingFrame const &)

virtual void	beginSubRun (SubRun const &, ProcessingFrame const &)

virtual void	endSubRun (SubRun const &, ProcessingFrame const &)

virtual bool	filter (Event &, ProcessingFrame const &)=0

Private Member Functions inherited from art::detail::EngineCreator
	EngineCreator (std::string const &label, ScheduleID sid)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

Additional Inherited Members
Static Public Attributes inherited from art::detail::Filter
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

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 Types inherited from art::detail::EngineCreator
using	base_engine_t = CLHEP::HepRandomEngine

using	label_t = RNGsnapshot::label_t

using	seed_t = long

using	engine_state_t = RNGsnapshot::engine_state_t

Detailed Description

Definition at line 17 of file ReplicatedFilter.h.

Member Typedef Documentation

using art::ReplicatedFilter::ModuleType = ReplicatedFilter

Definition at line 20 of file ReplicatedFilter.h.

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

Definition at line 21 of file ReplicatedFilter.h.

Constructor & Destructor Documentation

art::ReplicatedFilter::ReplicatedFilter	(	fhicl::ParameterSet const &	pset,
		ProcessingFrame const &	frame
	)

inlineexplicit

Definition at line 25 of file ReplicatedFilter.h.

       : detail::Filter{pset}
       , detail::EngineCreator{pset.get<std::string>("module_label"),
                               frame.scheduleID()}
     {}

template<typename Config >

art::ReplicatedFilter::ReplicatedFilter	(	Table< Config > const &	config,
		ProcessingFrame const &	frame
	)

inlineexplicit

Definition at line 33 of file ReplicatedFilter.h.

35 : ReplicatedFilter{config.get_PSet(), frame}

36 {}

config

static Config * config

Definition: config.cpp:1054

art::ReplicatedFilter::ReplicatedFilter

ReplicatedFilter(fhicl::ParameterSet const &pset, ProcessingFrame const &frame)

Definition: ReplicatedFilter.h:25

Member Function Documentation

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

privatevirtual

Definition at line 99 of file ReplicatedFilter.cc.

100 {}

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

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 51 of file ReplicatedFilter.cc.

   {
     beginJob(frame);
   }

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

privatevirtual

Definition at line 127 of file ReplicatedFilter.cc.

128 {}

bool art::ReplicatedFilter::beginRunWithFrame	(	Run &	r,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 63 of file ReplicatedFilter.cc.

   {
     beginRun(r, frame);
     return true;
   }

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

privatevirtual

Definition at line 135 of file ReplicatedFilter.cc.

136 {}

bool art::ReplicatedFilter::beginSubRunWithFrame	(	SubRun &	sr,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 77 of file ReplicatedFilter.cc.

   {
     beginSubRun(sr, frame);
     return true;
   }

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

privatevirtual

Definition at line 103 of file ReplicatedFilter.cc.

104 {}

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

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 57 of file ReplicatedFilter.cc.

   {
     endJob(frame);
   }

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

privatevirtual

Definition at line 131 of file ReplicatedFilter.cc.

132 {}

bool art::ReplicatedFilter::endRunWithFrame	(	Run &	r,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 70 of file ReplicatedFilter.cc.

   {
     endRun(r, frame);
     return true;
   }

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

privatevirtual

Definition at line 139 of file ReplicatedFilter.cc.

140 {}

bool art::ReplicatedFilter::endSubRunWithFrame	(	SubRun &	sr,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 85 of file ReplicatedFilter.cc.

   {
     endSubRun(sr, frame);
     return true;
   }

virtual bool art::ReplicatedFilter::filter	(	Event &	,
		ProcessingFrame const &
	)

privatepure virtual

bool art::ReplicatedFilter::filterWithFrame	(	Event &	e,
		ProcessingFrame const &	frame
	)

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 92 of file ReplicatedFilter.cc.

   {
     return filter(e, frame);
   }

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

privatevirtual

Definition at line 112 of file ReplicatedFilter.cc.

114 {}

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

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 27 of file ReplicatedFilter.cc.

   {
     respondToCloseInputFile(fb, frame);
   }

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

privatevirtual

Definition at line 122 of file ReplicatedFilter.cc.

124 {}

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

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 43 of file ReplicatedFilter.cc.

   {
     respondToCloseOutputFiles(fb, frame);
   }

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

privatevirtual

Definition at line 107 of file ReplicatedFilter.cc.

109 {}

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

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 19 of file ReplicatedFilter.cc.

   {
     respondToOpenInputFile(fb, frame);
   }

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

privatevirtual

Definition at line 117 of file ReplicatedFilter.cc.

119 {}

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

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 35 of file ReplicatedFilter.cc.

   {
     respondToOpenOutputFiles(fb, frame);
   }

void art::ReplicatedFilter::setupQueues ( detail::SharedResources const & )

finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 13 of file ReplicatedFilter.cc.

   {
     // For art 3.0, replicated modules will not have queues.
   }

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

Definition at line 7 of file ReplicatedFilter.cc.

   {
     return "WorkerT<ReplicatedFilter>";
   }

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

art/art/Framework/Core/ReplicatedFilter.h
art/art/Framework/Core/ReplicatedFilter.cc

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation