edm::WorkerRegistry Class Reference

The Registry of all workers that where requested Holds all instances of workers. In this implementation, Workers are owned. More...

#include "edm/WorkerRegistry.h"

Public Member Functions
void	clear ()
void	deleteModule (std::string const &moduleLabel)
	Deletes the module of the Worker, but the Worker continues to exist. More...
Worker const *	get (std::string const &moduleLabel) const
Worker *	getWorker (WorkerParams const &p, std::string const &moduleLabel)
	Retrieve the particular instance of the worker. More...
WorkerRegistry &	operator= (WorkerRegistry const &)=delete
	WorkerRegistry (std::shared_ptr< ActivityRegistry > areg)
	WorkerRegistry (std::shared_ptr< ActivityRegistry > areg, std::shared_ptr< ModuleRegistry > iModReg)
	WorkerRegistry (WorkerRegistry &&)=default
	WorkerRegistry (WorkerRegistry const &)=delete
	~WorkerRegistry ()

Private Types
typedef std::map< std::string, edm::propagate_const < std::shared_ptr< Worker > > >	WorkerMap
	the container of workers More...

Private Attributes
std::shared_ptr< ActivityRegistry >	actReg_
WorkerMap	m_workerMap
	internal map of registered workers (owned). More...
edm::propagate_const < std::shared_ptr < ModuleRegistry > >	modRegistry_

Detailed Description

The Registry of all workers that where requested Holds all instances of workers. In this implementation, Workers are owned.

Definition at line 38 of file WorkerRegistry.h.

Member Typedef Documentation

typedef std::map<std::string, edm::propagate_const<std::shared_ptr<Worker> > > edm::WorkerRegistry::WorkerMap

private

the container of workers

Definition at line 65 of file WorkerRegistry.h.

Constructor & Destructor Documentation

edm::WorkerRegistry::WorkerRegistry ( std::shared_ptr< ActivityRegistry >  areg )

explicit

Definition at line 18 of file WorkerRegistry.cc.

      : modRegistry_(new ModuleRegistry), m_workerMap(), actReg_(areg) {}

edm::WorkerRegistry::WorkerRegistry	(	std::shared_ptr< ActivityRegistry >	areg,
		std::shared_ptr< ModuleRegistry >	iModReg
	)

Definition at line 21 of file WorkerRegistry.cc.

      : modRegistry_(modReg), m_workerMap(), actReg_(areg) {}

edm::WorkerRegistry::~WorkerRegistry

(

)

Definition at line 24 of file WorkerRegistry.cc.

{}

edm::WorkerRegistry::WorkerRegistry ( WorkerRegistry &&  )

default

edm::WorkerRegistry::WorkerRegistry ( WorkerRegistry const &  )

delete

Member Function Documentation

void edm::WorkerRegistry::clear

(

void

)

Definition at line 26 of file WorkerRegistry.cc.

References m_workerMap.

{ m_workerMap.clear(); }

void edm::WorkerRegistry::deleteModule

(

std::string const &

moduleLabel

)

Deletes the module of the Worker, but the Worker continues to exist.

Definition at line 56 of file WorkerRegistry.cc.

References Exception, and m_workerMap.

Referenced by edm::WorkerManager::deleteModuleIfExists().

                                                                {
    WorkerMap::iterator workerIt = m_workerMap.find(moduleLabel);
    if (workerIt == m_workerMap.end()) {
      throw cms::Exception("LogicError")
          << "WorkerRegistry::deleteModule() Trying to delete the module of a Worker with label " << moduleLabel
          << " but no such Worker exists in the WorkerRegistry. Please contact framework developers.";
    }
    workerIt->second->clearModule();
  }

Worker const * edm::WorkerRegistry::get

(

std::string const &

moduleLabel

)

const

Retrieve particular instance of the worker without creating it If one doesn't exist, returns nullptr

Definition at line 48 of file WorkerRegistry.cc.

References m_workerMap.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), edm::WorkerManager::deleteModuleIfExists(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

                                                                      {
    WorkerMap::const_iterator workerIt = m_workerMap.find(moduleLabel);
    if (workerIt != m_workerMap.end()) {
      return workerIt->second;
    }
    return nullptr;
  }

Worker * edm::WorkerRegistry::getWorker	(	WorkerParams const &	p,
		std::string const &	moduleLabel
	)

Retrieve the particular instance of the worker.

If the worker with that set of parameters does not exist, create it

Note

Workers are owned by this class, do not delete them

Definition at line 28 of file WorkerRegistry.cc.

References edm::WorkerParams::actions_, actReg_, m_workerMap, modRegistry_, edm::WorkerParams::preallocate_, edm::WorkerParams::processConfiguration_, edm::WorkerParams::pset_, and edm::WorkerParams::reg_.

Referenced by edm::WorkerManager::getWorker().

                                                                                       {
    WorkerMap::iterator workerIt = m_workerMap.find(moduleLabel);

    // if the worker is not there, make it
    if (workerIt == m_workerMap.end()) {
      MakeModuleParams mmp(p.pset_, *p.reg_, p.preallocate_, p.processConfiguration_);
      auto modulePtr = modRegistry_->getModule(
          mmp, moduleLabel, actReg_->preModuleConstructionSignal_, actReg_->postModuleConstructionSignal_);
      auto workerPtr = modulePtr->makeWorker(p.actions_);

      workerPtr->setActivityRegistry(actReg_);

      // Transfer ownership of worker to the registry
      m_workerMap[moduleLabel] =
          std::shared_ptr<Worker>(workerPtr.release());  // propagate_const<T> has no reset() function
      return m_workerMap[moduleLabel].get();
    }
    return (workerIt->second.get());
  }

WorkerRegistry& edm::WorkerRegistry::operator= ( WorkerRegistry const &  )

delete

Member Data Documentation

std::shared_ptr<ActivityRegistry> edm::WorkerRegistry::actReg_

private

Definition at line 71 of file WorkerRegistry.h.

Referenced by getWorker().

WorkerMap edm::WorkerRegistry::m_workerMap

private

internal map of registered workers (owned).

Definition at line 70 of file WorkerRegistry.h.

Referenced by clear(), deleteModule(), get(), and getWorker().

edm::propagate_const<std::shared_ptr<ModuleRegistry> > edm::WorkerRegistry::modRegistry_

private

Definition at line 67 of file WorkerRegistry.h.

Referenced by getWorker().