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

#include <ReplicatedProducer.h>

Inheritance diagram for art::ReplicatedProducer:
art::detail::Producer art::detail::EngineCreator art::Modifier art::ModuleBase art::ProductRegistryHelper art::TriggerResultInserter

Public Types

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

 ReplicatedProducer (fhicl::ParameterSet const &pset, ProcessingFrame const &frame)
 
template<typename Config >
 ReplicatedProducer (Table< Config > const &config, ProcessingFrame const &frame)
 
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
 
Produceroperator= (Producer const &)=delete
 
Produceroperator= (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
 
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
 
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 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 void produce (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

- 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 19 of file ReplicatedProducer.h.

Member Typedef Documentation

Definition at line 22 of file ReplicatedProducer.h.

Definition at line 23 of file ReplicatedProducer.h.

Constructor & Destructor Documentation

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

Definition at line 28 of file ReplicatedProducer.h.

30  : detail::Producer{pset}
31  , detail::EngineCreator{pset.get<std::string>("module_label", {}),
32  frame.scheduleID()}
33  {}
std::string string
Definition: nybbler.cc:12
template<typename Config >
art::ReplicatedProducer::ReplicatedProducer ( Table< Config > const &  config,
ProcessingFrame const &  frame 
)
inlineexplicit

Definition at line 36 of file ReplicatedProducer.h.

38  : ReplicatedProducer{config.get_PSet(), frame}
39  {}
ReplicatedProducer(fhicl::ParameterSet const &pset, ProcessingFrame const &frame)
static Config * config
Definition: config.cpp:1054

Member Function Documentation

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

Definition at line 98 of file ReplicatedProducer.cc.

99  {}
void art::ReplicatedProducer::beginJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 53 of file ReplicatedProducer.cc.

54  {
55  beginJob(frame);
56  }
virtual void beginJob(ProcessingFrame const &)
void art::ReplicatedProducer::beginRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 126 of file ReplicatedProducer.cc.

127  {}
void art::ReplicatedProducer::beginRunWithFrame ( Run r,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 65 of file ReplicatedProducer.cc.

66  {
67  beginRun(r, frame);
68  }
virtual void beginRun(Run const &, ProcessingFrame const &)
void art::ReplicatedProducer::beginSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 134 of file ReplicatedProducer.cc.

135  {}
void art::ReplicatedProducer::beginSubRunWithFrame ( SubRun sr,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 77 of file ReplicatedProducer.cc.

79  {
80  beginSubRun(sr, frame);
81  }
virtual void beginSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
void art::ReplicatedProducer::endJob ( ProcessingFrame const &  )
privatevirtual

Definition at line 102 of file ReplicatedProducer.cc.

103  {}
void art::ReplicatedProducer::endJobWithFrame ( ProcessingFrame const &  frame)
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 59 of file ReplicatedProducer.cc.

60  {
61  endJob(frame);
62  }
virtual void endJob(ProcessingFrame const &)
void art::ReplicatedProducer::endRun ( Run const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 130 of file ReplicatedProducer.cc.

131  {}
void art::ReplicatedProducer::endRunWithFrame ( Run r,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 71 of file ReplicatedProducer.cc.

72  {
73  endRun(r, frame);
74  }
virtual void endRun(Run const &, ProcessingFrame const &)
void art::ReplicatedProducer::endSubRun ( SubRun const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 138 of file ReplicatedProducer.cc.

139  {}
void art::ReplicatedProducer::endSubRunWithFrame ( SubRun sr,
ProcessingFrame const &  frame 
)
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 84 of file ReplicatedProducer.cc.

86  {
87  endSubRun(sr, frame);
88  }
virtual void endSubRun(SubRun const &, ProcessingFrame const &)
static constexpr double sr
Definition: Units.h:166
virtual void art::ReplicatedProducer::produce ( Event ,
ProcessingFrame const &   
)
privatepure virtual

Implemented in art::TriggerResultInserter.

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

Implements art::detail::Producer.

Definition at line 91 of file ReplicatedProducer.cc.

92  {
93  produce(e, frame);
94  }
const double e
virtual void produce(Event &, ProcessingFrame const &)=0
void art::ReplicatedProducer::respondToCloseInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 111 of file ReplicatedProducer.cc.

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

Implements art::detail::Producer.

Definition at line 29 of file ReplicatedProducer.cc.

32  {
33  respondToCloseInputFile(fb, frame);
34  }
virtual void respondToCloseInputFile(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedProducer::respondToCloseOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 121 of file ReplicatedProducer.cc.

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

Implements art::detail::Producer.

Definition at line 45 of file ReplicatedProducer.cc.

48  {
49  respondToCloseOutputFiles(fb, frame);
50  }
virtual void respondToCloseOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedProducer::respondToOpenInputFile ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 106 of file ReplicatedProducer.cc.

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

Implements art::detail::Producer.

Definition at line 21 of file ReplicatedProducer.cc.

24  {
25  respondToOpenInputFile(fb, frame);
26  }
virtual void respondToOpenInputFile(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedProducer::respondToOpenOutputFiles ( FileBlock const &  ,
ProcessingFrame const &   
)
privatevirtual

Definition at line 116 of file ReplicatedProducer.cc.

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

Implements art::detail::Producer.

Definition at line 37 of file ReplicatedProducer.cc.

40  {
41  respondToOpenOutputFiles(fb, frame);
42  }
virtual void respondToOpenOutputFiles(FileBlock const &, ProcessingFrame const &)
void art::ReplicatedProducer::setupQueues ( detail::SharedResources const &  )
finaloverrideprivatevirtual

Implements art::detail::Producer.

Definition at line 15 of file ReplicatedProducer.cc.

16  {
17  // For art 3.0, replicated modules will not have queues.
18  }
string art::ReplicatedProducer::workerType ( ) const

Definition at line 9 of file ReplicatedProducer.cc.

10  {
11  return "WorkerT<ReplicatedProducer>";
12  }

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