Public Types | Public Member Functions | Private Member Functions | List of all members
art::ReplicatedFilter Class Referenceabstract

#include <ReplicatedFilter.h>

Inheritance diagram for art::ReplicatedFilter:
art::detail::Filter art::detail::EngineCreator art::Modifier art::ModuleBase art::ProductRegistryHelper

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
 
Filteroperator= (Filter const &)=delete
 
Filteroperator= (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
 
Modifieroperator= (Modifier const &)=delete
 
Modifieroperator= (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_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (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
ConsumesCollectorconsumesCollector ()
 
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

Definition at line 20 of file ReplicatedFilter.h.

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.

27  : detail::Filter{pset}
28  , detail::EngineCreator{pset.get<std::string>("module_label"),
29  frame.scheduleID()}
30  {}
std::string string
Definition: nybbler.cc:12
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  {}
static Config * config
Definition: config.cpp:1054
ReplicatedFilter(fhicl::ParameterSet const &pset, ProcessingFrame const &frame)

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.

52  {
53  beginJob(frame);
54  }
virtual void beginJob(ProcessingFrame const &)
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.

64  {
65  beginRun(r, frame);
66  return true;
67  }
virtual void beginRun(Run const &, ProcessingFrame const &)
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.

79  {
80  beginSubRun(sr, frame);
81  return true;
82  }
virtual void beginSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
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.

58  {
59  endJob(frame);
60  }
virtual void endJob(ProcessingFrame const &)
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.

71  {
72  endRun(r, frame);
73  return true;
74  }
virtual void endRun(Run const &, ProcessingFrame const &)
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.

86  {
87  endSubRun(sr, frame);
88  return true;
89  }
virtual void endSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
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.

93  {
94  return filter(e, frame);
95  }
const double e
virtual bool filter(Event &, ProcessingFrame const &)=0
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.

30  {
31  respondToCloseInputFile(fb, frame);
32  }
virtual void respondToCloseInputFile(FileBlock const &, ProcessingFrame const &)
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.

46  {
47  respondToCloseOutputFiles(fb, frame);
48  }
virtual void respondToCloseOutputFiles(FileBlock const &, ProcessingFrame const &)
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.

22  {
23  respondToOpenInputFile(fb, frame);
24  }
virtual void respondToOpenInputFile(FileBlock const &, ProcessingFrame const &)
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.

38  {
39  respondToOpenOutputFiles(fb, frame);
40  }
virtual void respondToOpenOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedFilter::setupQueues ( detail::SharedResources const &  )
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 13 of file ReplicatedFilter.cc.

14  {
15  // For art 3.0, replicated modules will not have queues.
16  }
std::string art::ReplicatedFilter::workerType ( ) const

Definition at line 7 of file ReplicatedFilter.cc.

8  {
9  return "WorkerT<ReplicatedFilter>";
10  }

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