edm::Maker Class Reference

#include <WorkerMaker.h>

Inheritance diagram for edm::Maker:

Public Member Functions
std::shared_ptr < maker::ModuleHolder >	makeModule (MakeModuleParams const &, signalslot::Signal< void(ModuleDescription const &)> &iPre, signalslot::Signal< void(ModuleDescription const &)> &iPost) const
std::shared_ptr < maker::ModuleHolder >	makeReplacementModule (edm::ParameterSet const &p) const
std::unique_ptr< Worker >	makeWorker (ExceptionToActionTable const *, maker::ModuleHolder const *) const
virtual	~Maker ()

Protected Member Functions
ModuleDescription	createModuleDescription (MakeModuleParams const &p) const
void	throwConfigurationException (ModuleDescription const &md, cms::Exception &iException) const
void	throwValidationException (MakeModuleParams const &p, cms::Exception &iException) const
void	validateEDMType (std::string const &edmType, MakeModuleParams const &p) const

Private Member Functions
virtual const std::string &	baseType () const =0
virtual void	fillDescriptions (ConfigurationDescriptions &iDesc) const =0
virtual std::shared_ptr < maker::ModuleHolder >	makeModule (edm::ParameterSet const &p) const =0
virtual std::unique_ptr< Worker >	makeWorker (ExceptionToActionTable const *actions, ModuleDescription const &md, maker::ModuleHolder const *mod) const =0

Detailed Description

Definition at line 21 of file WorkerMaker.h.

Constructor & Destructor Documentation

edm::Maker::~Maker ( )

virtual

Definition at line 16 of file WorkerMaker.cc.

{}

Member Function Documentation

virtual const std::string& edm::Maker::baseType ( ) const

privatepure virtual

Implemented in edm::WorkerMaker< T >.

Referenced by makeModule().

ModuleDescription edm::Maker::createModuleDescription ( MakeModuleParams const &  p ) const

protected

Definition at line 18 of file WorkerMaker.cc.

References edm::ParameterSet::getParameter(), edm::ModuleDescription::getUniqueID(), edm::ParameterSet::id(), edm::MakeModuleParams::processConfiguration_, edm::MakeModuleParams::pset_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by makeModule().

                                                                                  {
    ParameterSet const& conf = *p.pset_;
    ModuleDescription md(conf.id(),
                         conf.getParameter<std::string>("@module_type"),
                         conf.getParameter<std::string>("@module_label"),
                         p.processConfiguration_.get(),
                         ModuleDescription::getUniqueID());
    return md;
  }

virtual void edm::Maker::fillDescriptions ( ConfigurationDescriptions &  iDesc ) const

privatepure virtual

Implemented in edm::WorkerMaker< T >.

Referenced by makeModule().

std::shared_ptr< maker::ModuleHolder > edm::Maker::makeModule	(	MakeModuleParams const &	p,
		signalslot::Signal< void(ModuleDescription const &)> &	iPre,
		signalslot::Signal< void(ModuleDescription const &)> &	iPost
	)		const

Definition at line 57 of file WorkerMaker.cc.

References edm::ParameterSet::addUntrackedParameter(), baseType(), CMS_SA_ALLOW, createModuleDescription(), fillDescriptions(), edm::ParameterSet::getParameter(), edm::pset::Registry::insertMapped(), edm::pset::Registry::instance(), callgraph::module, edm::MakeModuleParams::preallocate_, edm::MakeModuleParams::processConfiguration_, edm::MakeModuleParams::pset_, edm::MakeModuleParams::reg_, edm::ParameterSet::registerIt(), AlCaHLTBitMon_QueryRunRegistry::string, throwConfigurationException(), throwValidationException(), edm::ConfigurationDescriptions::validate(), validateEDMType(), and edm::convertException::wrap().

Referenced by makeReplacementModule().

                                                                    {
    // Add process_name for SwitchProducer
    if (p.pset_->getParameter<std::string>("@module_type") == "SwitchProducer") {
      p.pset_->addUntrackedParameter("@process_name", p.processConfiguration_->processName());
    }

    ConfigurationDescriptions descriptions(baseType(), p.pset_->getParameter<std::string>("@module_type"));
    fillDescriptions(descriptions);
    try {
      convertException::wrap([&]() {
        descriptions.validate(*p.pset_, p.pset_->getParameter<std::string>("@module_label"));
        validateEDMType(baseType(), p);
      });
    } catch (cms::Exception& iException) {
      throwValidationException(p, iException);
    }
    p.pset_->registerIt();
    //Need to be certain top level untracked parameters are stored in
    // the registry even if another PSet already exists in the
    // registry from a previous process
    //NOTE: a better implementation would be to change ParameterSet::registerIt
    // but that would require rebuilding much more code so will be done at
    // a later date.
    edm::pset::Registry::instance()->insertMapped(*(p.pset_), true);

    ModuleDescription md = createModuleDescription(p);
    std::shared_ptr<maker::ModuleHolder> module;
    bool postCalled = false;
    try {
      convertException::wrap([&]() {
        pre(md);
        module = makeModule(*(p.pset_));
        module->setModuleDescription(md);
        module->preallocate(*(p.preallocate_));
        module->registerProductsAndCallbacks(p.reg_);
        // if exception then post will be called in the catch block
        postCalled = true;
        post(md);
      });
    } catch (cms::Exception& iException) {
      if (!postCalled) {
        CMS_SA_ALLOW try { post(md); } catch (...) {
          // If post throws an exception ignore it because we are already handling another exception
        }
      }
      throwConfigurationException(md, iException);
    }
    return module;
  }

virtual std::shared_ptr<maker::ModuleHolder> edm::Maker::makeModule ( edm::ParameterSet const &  p ) const

privatepure virtual

Implemented in edm::WorkerMaker< T >.

std::shared_ptr<maker::ModuleHolder> edm::Maker::makeReplacementModule ( edm::ParameterSet const &  p ) const

inline

Definition at line 29 of file WorkerMaker.h.

References makeModule().

                                                                                           {
      return makeModule(p);
    }

std::unique_ptr< Worker > edm::Maker::makeWorker	(	ExceptionToActionTable const *	actions,
		maker::ModuleHolder const *	mod
	)		const

Definition at line 110 of file WorkerMaker.cc.

References mod(), and edm::maker::ModuleHolder::moduleDescription().

Referenced by edm::maker::ModuleHolder::makeWorker().

                                                                                {
    return makeWorker(actions, mod->moduleDescription(), mod);
  }

virtual std::unique_ptr<Worker> edm::Maker::makeWorker ( ExceptionToActionTable const *  actions, ModuleDescription const &  md, maker::ModuleHolder const *  mod  ) const

privatepure virtual

Implemented in edm::WorkerMaker< T >.

void edm::Maker::throwConfigurationException ( ModuleDescription const &  md, cms::Exception &  iException  ) const

protected

Definition at line 39 of file WorkerMaker.cc.

References cms::Exception::addContext(), edm::ModuleDescription::moduleLabel(), and edm::ModuleDescription::moduleName().

Referenced by makeModule().

                                                                                                     {
    std::ostringstream ost;
    ost << "Constructing module: class=" << md.moduleName() << " label='" << md.moduleLabel() << "'";
    iException.addContext(ost.str());
    throw;
  }

void edm::Maker::throwValidationException ( MakeModuleParams const &  p, cms::Exception &  iException  ) const

protected

Definition at line 28 of file WorkerMaker.cc.

References cms::Exception::addContext(), edm::ParameterSet::getParameter(), edm::moduleName(), edm::MakeModuleParams::pset_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by makeModule().

                                                                                                {
    ParameterSet const& conf = *p.pset_;
    std::string moduleName = conf.getParameter<std::string>("@module_type");
    std::string moduleLabel = conf.getParameter<std::string>("@module_label");

    std::ostringstream ost;
    ost << "Validating configuration of module: class=" << moduleName << " label='" << moduleLabel << "'";
    iException.addContext(ost.str());
    throw;
  }

void edm::Maker::validateEDMType ( std::string const &  edmType, MakeModuleParams const &  p  ) const

protected

Definition at line 46 of file WorkerMaker.cc.

References edm::errors::Configuration, Exception, edm::ParameterSet::getParameter(), edm::MakeModuleParams::pset_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by makeModule().

                                                                                       {
    std::string expected = p.pset_->getParameter<std::string>("@module_edm_type");
    if (edmType != expected) {
      throw Exception(errors::Configuration)
          << "The base type in the python configuration is " << expected << ", but the base type\n"
          << "for the module's C++ class is " << edmType << ". "
          << "Please fix the configuration.\n"
          << "It must use the same base type as the C++ class.\n";
    }
  }