CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
edm::ModuleRegistry Class Reference

#include "FWCore/Framework/interface/ModuleRegistry.h"

Public Member Functions

void deleteModule (std::string const &iModuleLabel, signalslot::Signal< void(ModuleDescription const &)> &iPre, signalslot::Signal< void(ModuleDescription const &)> &iPost)
 
template<typename F >
void forAllModuleHolders (F iFunc)
 
std::shared_ptr< maker::ModuleHoldergetModule (MakeModuleParams const &p, std::string const &moduleLabel, signalslot::Signal< void(ModuleDescription const &)> &iPre, signalslot::Signal< void(ModuleDescription const &)> &iPost)
 
 ModuleRegistry ()=default
 
 ModuleRegistry (std::unique_ptr< ModuleTypeResolverBase >)
 
maker::ModuleHolderreplaceModule (std::string const &iModuleLabel, edm::ParameterSet const &iPSet, edm::PreallocationConfiguration const &)
 

Private Attributes

std::map< std::string, edm::propagate_const< std::shared_ptr< maker::ModuleHolder > > > labelToModule_
 
std::unique_ptr< ModuleTypeResolverBasetypeResolver_
 

Detailed Description

Description: Constructs and owns framework modules

Usage: <usage>

Definition at line 41 of file ModuleRegistry.h.

Constructor & Destructor Documentation

◆ ModuleRegistry() [1/2]

edm::ModuleRegistry::ModuleRegistry ( )
default

◆ ModuleRegistry() [2/2]

edm::ModuleRegistry::ModuleRegistry ( std::unique_ptr< ModuleTypeResolverBase )
explicit

Member Function Documentation

◆ deleteModule()

void edm::ModuleRegistry::deleteModule ( std::string const &  iModuleLabel,
signalslot::Signal< void(ModuleDescription const &)> &  iPre,
signalslot::Signal< void(ModuleDescription const &)> &  iPost 
)

Definition at line 53 of file ModuleRegistry.cc.

References CMS_SA_ALLOW, Exception, and labelToModule_.

55  {
56  auto modItr = labelToModule_.find(iModuleLabel);
57  if (modItr == labelToModule_.end()) {
58  throw cms::Exception("LogicError")
59  << "Trying to delete module " << iModuleLabel
60  << " but it does not exist in the ModuleRegistry. Please contact framework developers.";
61  }
62  // If iPost throws and exception, let it propagate
63  // If deletion throws an exception, capture it and call iPost before throwing an exception
64  // If iPost throws an exception, let it propagate
65  auto md = modItr->second->moduleDescription();
66  iPre(modItr->second->moduleDescription());
67  bool postCalled = false;
68  // exception is rethrown
69  CMS_SA_ALLOW try {
70  labelToModule_.erase(modItr);
71  // if exception then post will be called in the catch block
72  postCalled = true;
73  iPost(md);
74  } catch (...) {
75  if (not postCalled) {
76  // we're already handling exception, nothing we can do if iPost throws
77  CMS_SA_ALLOW try { iPost(md); } catch (...) {
78  }
79  }
80  throw;
81  }
82  }
#define CMS_SA_ALLOW
std::map< std::string, edm::propagate_const< std::shared_ptr< maker::ModuleHolder > > > labelToModule_

◆ forAllModuleHolders()

template<typename F >
void edm::ModuleRegistry::forAllModuleHolders ( F  iFunc)
inline

Definition at line 59 of file ModuleRegistry.h.

References labelToModule_, and submitPVValidationJobs::t.

Referenced by edm::StreamSchedule::initializeEarlyDelete().

59  {
60  for (auto& labelMod : labelToModule_) {
61  maker::ModuleHolder* t = labelMod.second.get();
62  iFunc(t);
63  }
64  }
std::map< std::string, edm::propagate_const< std::shared_ptr< maker::ModuleHolder > > > labelToModule_

◆ getModule()

std::shared_ptr< maker::ModuleHolder > edm::ModuleRegistry::getModule ( MakeModuleParams const &  p,
std::string const &  moduleLabel,
signalslot::Signal< void(ModuleDescription const &)> &  iPre,
signalslot::Signal< void(ModuleDescription const &)> &  iPost 
)

Definition at line 20 of file ModuleRegistry.cc.

References edm::Factory::get(), edm::get_underlying_safe(), labelToModule_, edm::Factory::makeModule(), HerwigMaxPtPartonFilter_cfi::moduleLabel, AlCaHLTBitMon_ParallelJobs::p, and typeResolver_.

24  {
25  auto modItr = labelToModule_.find(moduleLabel);
26  if (modItr == labelToModule_.end()) {
27  auto modPtr = Factory::get()->makeModule(p, typeResolver_.get(), iPre, iPost);
28 
29  // Transfer ownership of worker to the registry
30  labelToModule_[moduleLabel] = modPtr;
31  return modPtr;
32  }
33  return get_underlying_safe(modItr->second);
34  }
std::unique_ptr< ModuleTypeResolverBase > typeResolver_
constexpr std::shared_ptr< T > & get_underlying_safe(propagate_const< std::shared_ptr< T >> &iP)
std::map< std::string, edm::propagate_const< std::shared_ptr< maker::ModuleHolder > > > labelToModule_
std::shared_ptr< maker::ModuleHolder > makeModule(const MakeModuleParams &, const ModuleTypeResolverBase *, signalslot::Signal< void(const ModuleDescription &)> &pre, signalslot::Signal< void(const ModuleDescription &)> &post) const
Definition: Factory.cc:39
static Factory const * get()
Definition: Factory.cc:21

◆ replaceModule()

maker::ModuleHolder * edm::ModuleRegistry::replaceModule ( std::string const &  iModuleLabel,
edm::ParameterSet const &  iPSet,
edm::PreallocationConfiguration const &  iPrealloc 
)

Definition at line 36 of file ModuleRegistry.cc.

References edm::Factory::get(), labelToModule_, and edm::Factory::makeReplacementModule().

38  {
39  auto modItr = labelToModule_.find(iModuleLabel);
40  if (modItr == labelToModule_.end()) {
41  return nullptr;
42  }
43 
44  auto modPtr = Factory::get()->makeReplacementModule(iPSet);
45  modPtr->setModuleDescription(modItr->second->moduleDescription());
46  modPtr->preallocate(iPrealloc);
47 
48  // Transfer ownership of worker to the registry
49  modItr->second = modPtr;
50  return modItr->second.get();
51  }
std::shared_ptr< maker::ModuleHolder > makeReplacementModule(const edm::ParameterSet &) const
Definition: Factory.cc:49
std::map< std::string, edm::propagate_const< std::shared_ptr< maker::ModuleHolder > > > labelToModule_
static Factory const * get()
Definition: Factory.cc:21

Member Data Documentation

◆ labelToModule_

std::map<std::string, edm::propagate_const<std::shared_ptr<maker::ModuleHolder> > > edm::ModuleRegistry::labelToModule_
private

Definition at line 67 of file ModuleRegistry.h.

Referenced by deleteModule(), forAllModuleHolders(), getModule(), and replaceModule().

◆ typeResolver_

std::unique_ptr<ModuleTypeResolverBase> edm::ModuleRegistry::typeResolver_
private

Definition at line 68 of file ModuleRegistry.h.

Referenced by getModule().