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

#include <SharedFilter.h>

Inheritance diagram for art::SharedFilter:
art::detail::Filter art::detail::SharedModule art::Modifier art::ModuleBase art::ProductRegistryHelper art::BlockingPrescaler art::EventIDFilter art::Prescaler simfilter::FilterNoMCParticles simfilter::FilterSimPhotonLiteTime simfilter::FilterSimPhotonTime

Public Types

using ModuleType = SharedFilter
 
using WorkerType = WorkerT< SharedFilter >
 
- 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

 SharedFilter (fhicl::ParameterSet const &pset)
 
template<typename Config >
 SharedFilter (Table< Config > const &config)
 
std::string workerType () const
 
- 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)
 
- 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 &resources) 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 &, ProcessingFrame const &)
 
virtual void endRun (Run &, ProcessingFrame const &)
 
virtual void beginSubRun (SubRun &, ProcessingFrame const &)
 
virtual void endSubRun (SubRun &, ProcessingFrame const &)
 
virtual bool filter (Event &, ProcessingFrame const &)=0
 

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 ()
 
- 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 17 of file SharedFilter.h.

Member Typedef Documentation

Definition at line 19 of file SharedFilter.h.

Definition at line 20 of file SharedFilter.h.

Constructor & Destructor Documentation

art::SharedFilter::SharedFilter ( fhicl::ParameterSet const &  pset)
inlineexplicit

Definition at line 22 of file SharedFilter.h.

23  : detail::Filter{pset}
24  , detail::SharedModule{pset.get<std::string>("module_label")}
25  {}
std::string string
Definition: nybbler.cc:12
template<typename Config >
art::SharedFilter::SharedFilter ( Table< Config > const &  config)
inlineexplicit

Definition at line 28 of file SharedFilter.h.

29  : SharedFilter{config.get_PSet()}
30  {}
SharedFilter(fhicl::ParameterSet const &pset)
Definition: SharedFilter.h:22
static Config * config
Definition: config.cpp:1054

Member Function Documentation

void art::SharedFilter::beginJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 94 of file SharedFilter.cc.

95  {}
void art::SharedFilter::beginJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 47 of file SharedFilter.cc.

48  {
49  beginJob(frame);
50  }
virtual void beginJob(ProcessingFrame const &)
Definition: SharedFilter.cc:94
void art::SharedFilter::beginRun ( Run ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 121 of file SharedFilter.cc.

122  {}
bool art::SharedFilter::beginRunWithFrame ( Run r,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 59 of file SharedFilter.cc.

60  {
61  beginRun(r, frame);
62  return true;
63  }
virtual void beginRun(Run &, ProcessingFrame const &)
void art::SharedFilter::beginSubRun ( SubRun ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 129 of file SharedFilter.cc.

130  {}
bool art::SharedFilter::beginSubRunWithFrame ( SubRun sr,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 73 of file SharedFilter.cc.

74  {
75  beginSubRun(sr, frame);
76  return true;
77  }
virtual void beginSubRun(SubRun &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
void art::SharedFilter::endJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 98 of file SharedFilter.cc.

99  {}
void art::SharedFilter::endJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 53 of file SharedFilter.cc.

54  {
55  endJob(frame);
56  }
virtual void endJob(ProcessingFrame const &)
Definition: SharedFilter.cc:98
void art::SharedFilter::endRun ( Run ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 125 of file SharedFilter.cc.

126  {}
bool art::SharedFilter::endRunWithFrame ( Run r,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 66 of file SharedFilter.cc.

67  {
68  endRun(r, frame);
69  return true;
70  }
virtual void endRun(Run &, ProcessingFrame const &)
void art::SharedFilter::endSubRun ( SubRun ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 133 of file SharedFilter.cc.

134  {}
bool art::SharedFilter::endSubRunWithFrame ( SubRun sr,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 80 of file SharedFilter.cc.

81  {
82  endSubRun(sr, frame);
83  return true;
84  }
virtual void endSubRun(SubRun &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
virtual bool art::SharedFilter::filter ( Event ,
ProcessingFrame const &   
)
privatepure virtual
bool art::SharedFilter::filterWithFrame ( Event e,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 87 of file SharedFilter.cc.

88  {
89  return filter(e, frame);
90  }
const double e
virtual bool filter(Event &, ProcessingFrame const &)=0
void art::SharedFilter::respondToCloseInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 106 of file SharedFilter.cc.

108  {}
void art::SharedFilter::respondToCloseInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 26 of file SharedFilter.cc.

28  {
29  respondToCloseInputFile(fb, frame);
30  }
virtual void respondToCloseInputFile(FileBlock const &, ProcessingFrame const &)
void art::SharedFilter::respondToCloseOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 116 of file SharedFilter.cc.

118  {}
void art::SharedFilter::respondToCloseOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 40 of file SharedFilter.cc.

42  {
43  respondToCloseOutputFiles(fb, frame);
44  }
virtual void respondToCloseOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::SharedFilter::respondToOpenInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 102 of file SharedFilter.cc.

103  {}
void art::SharedFilter::respondToOpenInputFileWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 19 of file SharedFilter.cc.

21  {
22  respondToOpenInputFile(fb, frame);
23  }
virtual void respondToOpenInputFile(FileBlock const &, ProcessingFrame const &)
void art::SharedFilter::respondToOpenOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 111 of file SharedFilter.cc.

113  {}
void art::SharedFilter::respondToOpenOutputFilesWithFrame ( FileBlock const &  fb,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 33 of file SharedFilter.cc.

35  {
36  respondToOpenOutputFiles(fb, frame);
37  }
virtual void respondToOpenOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::SharedFilter::setupQueues ( detail::SharedResources const &  resources)
finaloverrideprivatevirtual

Implements art::detail::Filter.

Definition at line 13 of file SharedFilter.cc.

14  {
15  createQueues(resources);
16  }
void createQueues(SharedResources const &resources)
Definition: SharedModule.cc:34
std::string art::SharedFilter::workerType ( ) const

Definition at line 7 of file SharedFilter.cc.

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

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