edm::eventsetup::ComponentMaker< T, TComponent > Class Template Reference

#include <ComponentMaker.h>

Inheritance diagram for edm::eventsetup::ComponentMaker< T, TComponent >:

Public Types
typedef T::base_type	base_type
Public Types inherited from edm::eventsetup::ComponentMakerBase< T >
typedef T::base_type	base_type

Public Member Functions
std::shared_ptr< base_type >	addTo (EventSetupsController &esController, EventSetupProvider &iProvider, ParameterSet &iConfiguration, bool replaceExisting) const override
	ComponentMaker ()
	ComponentMaker (const ComponentMaker &)=delete
const ComponentMaker &	operator= (const ComponentMaker &)=delete
Public Member Functions inherited from edm::eventsetup::ComponentMakerBaseHelper
virtual	~ComponentMakerBaseHelper ()

Private Member Functions
void	setDescription (ESProductResolverProvider *iProv, const ComponentDescription &iDesc) const
void	setDescription (void *, const ComponentDescription &) const
void	setDescriptionForFinder (EventSetupRecordIntervalFinder *iFinder, const ComponentDescription &iDesc) const
void	setDescriptionForFinder (void *, const ComponentDescription &) const
void	setPostConstruction (ESProductResolverProvider *iProv, const edm::ParameterSet &iPSet) const
void	setPostConstruction (void *, const edm::ParameterSet &) const

Additional Inherited Members
Protected Member Functions inherited from edm::eventsetup::ComponentMakerBaseHelper
ComponentDescription	createComponentDescription (ParameterSet const &iConfiguration) const

Detailed Description

template<class T, class TComponent>
class edm::eventsetup::ComponentMaker< T, TComponent >

Definition at line 61 of file ComponentMaker.h.

Member Typedef Documentation

base_type

template<class T, class TComponent>

typedef T::base_type edm::eventsetup::ComponentMaker< T, TComponent >::base_type

Definition at line 66 of file ComponentMaker.h.

Constructor & Destructor Documentation

ComponentMaker() [1/2]

template<class T, class TComponent>

edm::eventsetup::ComponentMaker< T, TComponent >::ComponentMaker ( )

inline

Definition at line 63 of file ComponentMaker.h.

{}

ComponentMaker() [2/2]

template<class T, class TComponent>

edm::eventsetup::ComponentMaker< T, TComponent >::ComponentMaker ( const ComponentMaker< T, TComponent > &  )

delete

Member Function Documentation

addTo()

template<class T , class TComponent >

std::shared_ptr< typename ComponentMaker< T, TComponent >::base_type > ComponentMaker::addTo ( EventSetupsController &  esController, EventSetupProvider &  iProvider, ParameterSet &  iConfiguration, bool  replaceExisting  ) const

overridevirtual

Implements edm::eventsetup::ComponentMakerBase< T >.

Definition at line 96 of file ComponentMaker.h.

                                    {
      // This adds components to the EventSetupProvider for the process. It might
      // make a new component then add it or reuse a component from an earlier
      // SubProcess or the top level process and add that.

      {
        auto modtype = iConfiguration.getParameter<std::string>("@module_type");
        auto moduleLabel = iConfiguration.getParameter<std::string>("@module_label");
        try {
          edm::convertException::wrap([&]() {
            ConfigurationDescriptions descriptions(T::baseType(), modtype);
            fillDetails::fillIfExists<TComponent>(descriptions);
            fillDetails::prevalidateIfExists<TComponent>(descriptions);
            descriptions.validate(iConfiguration, moduleLabel);
            iConfiguration.registerIt();
          });
        } catch (cms::Exception& iException) {
          iException.addContext(fmt::format(
              "Validating configuration of {} of type {} with label: '{}'", T::baseType(), modtype, moduleLabel));
          throw;
        }
      }

      if (!replaceExisting) {
        std::shared_ptr<typename T::base_type> alreadyMadeComponent =
            T::getComponentAndRegisterProcess(esController, iConfiguration);

        if (alreadyMadeComponent) {
          // This is for the case when a component is shared between
          // a SubProcess and a previous SubProcess or the top level process
          // because the component has an identical configuration to a component
          // from the top level process or earlier SubProcess.
          std::shared_ptr<TComponent> component(
              std::static_pointer_cast<TComponent, typename T::base_type>(alreadyMadeComponent));
          T::addTo(iProvider, component, iConfiguration, true);
          return component;
        }
      }

      std::shared_ptr<TComponent> component = std::make_shared<TComponent>(iConfiguration);
      ComponentDescription description = this->createComponentDescription(iConfiguration);

      this->setDescription(component.get(), description);
      this->setDescriptionForFinder(component.get(), description);
      this->setPostConstruction(component.get(), iConfiguration);

      if (replaceExisting) {
        // This case is for ESProducers where in the first pass
        // the algorithm thought the component could be shared
        // across SubProcess's because there was an ESProducer
        // from a previous process with an identical configuration.
        // But in a later check it was determined that sharing was not
        // possible because other components associated with the
        // same record or records that record depends on had
        // differing configurations.
        T::replaceExisting(iProvider, component);
      } else {
        // This is for the case when a new component is being constructed.
        // All components for the top level process fall in this category.
        // Or it could be a SubProcess where neither the top level process
        // nor any prior SubProcess had a component with exactly the same configuration.
        T::addTo(iProvider, component, iConfiguration, false);
        T::putComponent(esController, iConfiguration, component);
      }
      return component;
    }

operator=()

template<class T, class TComponent>

const ComponentMaker& edm::eventsetup::ComponentMaker< T, TComponent >::operator= ( const ComponentMaker< T, TComponent > &  )

delete

setDescription() [1/2]

template<class T, class TComponent>

void edm::eventsetup::ComponentMaker< T, TComponent >::setDescription ( ESProductResolverProvider *  iProv, const ComponentDescription &  iDesc  ) const

inlineprivate

Definition at line 78 of file ComponentMaker.h.

                                                                                                     {
        iProv->setDescription(iDesc);
      }

setDescription() [2/2]

template<class T, class TComponent>

void edm::eventsetup::ComponentMaker< T, TComponent >::setDescription ( void *  , const ComponentDescription &    ) const

inlineprivate

Definition at line 89 of file ComponentMaker.h.

{}

setDescriptionForFinder() [1/2]

template<class T, class TComponent>

void edm::eventsetup::ComponentMaker< T, TComponent >::setDescriptionForFinder ( EventSetupRecordIntervalFinder *  iFinder, const ComponentDescription &  iDesc  ) const

inlineprivate

Definition at line 81 of file ComponentMaker.h.

                                                                                                                     {
        iFinder->setDescriptionForFinder(iDesc);
      }

setDescriptionForFinder() [2/2]

template<class T, class TComponent>

void edm::eventsetup::ComponentMaker< T, TComponent >::setDescriptionForFinder ( void *  , const ComponentDescription &    ) const

inlineprivate

Definition at line 90 of file ComponentMaker.h.

{}

setPostConstruction() [1/2]

template<class T, class TComponent>

void edm::eventsetup::ComponentMaker< T, TComponent >::setPostConstruction ( ESProductResolverProvider *  iProv, const edm::ParameterSet &  iPSet  ) const

inlineprivate

Definition at line 84 of file ComponentMaker.h.

                                                                                                     {
        //The 'appendToDataLabel' parameter was added very late in the development cycle and since
        // the ParameterSet is not sent to the base class we must set the value after construction
        iProv->setAppendToDataLabel(iPSet);
      }

setPostConstruction() [2/2]

template<class T, class TComponent>

void edm::eventsetup::ComponentMaker< T, TComponent >::setPostConstruction ( void *  , const edm::ParameterSet &    ) const

inlineprivate

Definition at line 91 of file ComponentMaker.h.

{}