edm::eventsetup::EventSetupRecordProvider Class Reference

#include <EventSetupRecordProvider.h>

Public Types
typedef std::map< DataKey, ComponentDescription >	DataToPreferredProviderMap

Public Member Functions
void	add (std::shared_ptr< DataProxyProvider >)
void	addFinder (std::shared_ptr< EventSetupRecordIntervalFinder >)
	For now, only use one finder. More...
void	addRecordTo (EventSetupProvider &)
void	addRecordToIfValid (EventSetupProvider &, IOVSyncValue const &)
std::vector< ComponentDescription const * >	componentsForRegisteredDataKeys () const
std::set< EventSetupRecordKey >	dependentRecords () const
	Returns the list of Records the provided Record depends on (usually none) More...
	EventSetupRecordProvider (EventSetupRecordKey const &iKey)
void	fillReferencedDataKeys (std::map< DataKey, ComponentDescription const * > &referencedDataKeys) const
std::shared_ptr< EventSetupRecordIntervalFinder const >	finder () const
std::shared_ptr< EventSetupRecordIntervalFinder > &	finder ()
void	getReferencedESProducers (std::map< EventSetupRecordKey, std::vector< ComponentDescription const * >> &referencedESProducers)
EventSetupRecordKey const &	key () const
std::shared_ptr< DataProxyProvider >	proxyProvider (ComponentDescription const &)
	returns the first matching DataProxyProvider or a 'null' if not found More...
std::shared_ptr< DataProxyProvider >	proxyProvider (ParameterSetIDHolder const &)
	returns the first matching DataProxyProvider or a 'null' if not found More...
std::set< ComponentDescription >	proxyProviderDescriptions () const
	return information on which DataProxyProviders are supplying information More...
EventSetupRecordImpl const &	record () const
EventSetupRecordImpl &	record ()
std::vector< DataKey >	registeredDataKeys () const
	The available DataKeys in the Record. The order can be used to request the data by index. More...
void	resetProxies ()
	This will clear the cache's of all the Proxies so that next time they are called they will run. More...
void	resetProxyProvider (ParameterSetIDHolder const &, std::shared_ptr< DataProxyProvider > const &)
void	resetRecordToProxyPointers (DataToPreferredProviderMap const &iMap)
void	setDependentProviders (std::vector< std::shared_ptr< EventSetupRecordProvider >> const &)
	If the provided Record depends on other Records, here are the dependent Providers. More...
void	setValidityInterval (ValidityInterval const &)
bool	setValidityIntervalFor (IOVSyncValue const &)
	sets interval to this time and returns true if have a valid interval for time More...
void	usePreferred (DataToPreferredProviderMap const &)
ValidityInterval const &	validityInterval () const

Protected Member Functions
void	addProxiesToRecord (std::shared_ptr< DataProxyProvider >, DataToPreferredProviderMap const &)
void	addProxiesToRecordHelper (edm::propagate_const< std::shared_ptr< DataProxyProvider >> &dpp, DataToPreferredProviderMap const &mp)
void	cacheReset ()
std::shared_ptr< EventSetupRecordIntervalFinder >	swapFinder (std::shared_ptr< EventSetupRecordIntervalFinder > iNew)

Private Member Functions
bool	checkResetTransients ()
	EventSetupRecordProvider (EventSetupRecordProvider const &)=delete
EventSetupRecordProvider const &	operator= (EventSetupRecordProvider const &)=delete
void	resetTransients ()

Private Attributes
edm::propagate_const< std::shared_ptr< EventSetupRecordIntervalFinder > >	finder_
EventSetupRecordKey const	key_
bool	lastSyncWasBeginOfRun_
std::unique_ptr< std::vector< edm::propagate_const< std::shared_ptr< EventSetupRecordIntervalFinder > > > >	multipleFinders_
std::vector< edm::propagate_const< std::shared_ptr< DataProxyProvider > > >	providers_
EventSetupRecordImpl	record_
ValidityInterval	validityInterval_

Detailed Description

Definition at line 46 of file EventSetupRecordProvider.h.

Member Typedef Documentation

typedef std::map<DataKey, ComponentDescription> edm::eventsetup::EventSetupRecordProvider::DataToPreferredProviderMap

Definition at line 48 of file EventSetupRecordProvider.h.

Constructor & Destructor Documentation

edm::eventsetup::EventSetupRecordProvider::EventSetupRecordProvider

(

EventSetupRecordKey const &

iKey

)

Referenced by swapFinder().

edm::eventsetup::EventSetupRecordProvider::EventSetupRecordProvider ( EventSetupRecordProvider const &  )

privatedelete

Member Function Documentation

void EventSetupRecordProvider::add

(

std::shared_ptr< DataProxyProvider >

iProvider

)

Definition at line 74 of file EventSetupRecordProvider.cc.

References edm::search_all().

Referenced by edm::eventsetup::EventSetupProvider::finishConfiguration(), record(), counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

                                                                                 {
      assert(iProvider->isUsingRecord(key_));
      edm::propagate_const<std::shared_ptr<DataProxyProvider>> pProvider(iProvider);
      assert(!search_all(providers_, pProvider));
      providers_.emplace_back(iProvider);
    }

void EventSetupRecordProvider::addFinder

(

std::shared_ptr< EventSetupRecordIntervalFinder >

iFinder

)

For now, only use one finder.

Definition at line 81 of file EventSetupRecordProvider.cc.

References Exception, and ghostTrackVertexReco_cff::finder.

Referenced by edm::eventsetup::EventSetupProvider::finishConfiguration(), and record().

                                                                                                  {
      auto oldFinder = finder();
      finder_ = iFinder;
      if (nullptr != multipleFinders_.get()) {
        multipleFinders_->emplace_back(iFinder);
      } else {
        //dependent records set there finders after the multipleFinders_ has been released
        // but they also have never had a finder set
        if (nullptr != oldFinder.get()) {
          cms::Exception("EventSetupMultipleSources")
              << "An additional source has been added to the Record " << key_.name() << "'\n"
              << "after all the other sources have been dealt with.  This is a logic error, please send email to the "
                 "framework group.";
        }
      }
    }

void EventSetupRecordProvider::addProxiesToRecord ( std::shared_ptr< DataProxyProvider >  , DataToPreferredProviderMap const &    )

protected

Definition at line 131 of file EventSetupRecordProvider.cc.

Referenced by addProxiesToRecordHelper().

                                                                                                                      {
      typedef DataProxyProvider::KeyedProxies ProxyList;
      typedef EventSetupRecordProvider::DataToPreferredProviderMap PreferredMap;

      const ProxyList& keyedProxies(iProvider->keyedProxies(this->key()));
      ProxyList::const_iterator finishedProxyList(keyedProxies.end());
      for (ProxyList::const_iterator keyedProxy(keyedProxies.begin()); keyedProxy != finishedProxyList; ++keyedProxy) {
        PreferredMap::const_iterator itFound = iMap.find(keyedProxy->first);
        if (iMap.end() != itFound) {
          if (itFound->second.type_ != keyedProxy->second->providerDescription()->type_ ||
              itFound->second.label_ != keyedProxy->second->providerDescription()->label_) {
            //this is not the preferred provider
            continue;
          }
        }
        record_.add((*keyedProxy).first, (*keyedProxy).second.get());
      }
    }

void edm::eventsetup::EventSetupRecordProvider::addProxiesToRecordHelper ( edm::propagate_const< std::shared_ptr< DataProxyProvider >> &  dpp, DataToPreferredProviderMap const &  mp  )

inlineprotected

Definition at line 112 of file EventSetupRecordProvider.h.

References addProxiesToRecord(), cacheReset(), and edm::get_underlying_safe().

Referenced by resetRecordToProxyPointers(), and usePreferred().

                                                                          {
        addProxiesToRecord(get_underlying_safe(dpp), mp);
      }

void EventSetupRecordProvider::addRecordTo

(

EventSetupProvider &

iEventSetupProvider

)

Definition at line 151 of file EventSetupRecordProvider.cc.

References edm::eventsetup::EventSetupProvider::addRecordToEventSetup().

Referenced by record().

                                                                                      {
      record_.set(this->validityInterval());
      iEventSetupProvider.addRecordToEventSetup(record_);
    }

void EventSetupRecordProvider::addRecordToIfValid	(	EventSetupProvider &	,
		IOVSyncValue const &
	)

Definition at line 166 of file EventSetupRecordProvider.cc.

Referenced by record().

                                                                                 {
      if (setValidityIntervalFor(iTime)) {
        addRecordTo(iEventSetupProvider);
      }
    }

void EventSetupRecordProvider::cacheReset ( )

protected

Definition at line 240 of file EventSetupRecordProvider.cc.

References record.

Referenced by addProxiesToRecordHelper().

{ record().cacheReset(); }

bool EventSetupRecordProvider::checkResetTransients ( )

private

Definition at line 242 of file EventSetupRecordProvider.cc.

References record.

Referenced by swapFinder().

{ return record().transientReset(); }

std::vector< ComponentDescription const * > EventSetupRecordProvider::componentsForRegisteredDataKeys

(

)

const

Definition at line 292 of file EventSetupRecordProvider.cc.

Referenced by record().

                                                                                                           {
      return record_.componentsForRegisteredDataKeys();
    }

std::set< EventSetupRecordKey > EventSetupRecordProvider::dependentRecords

(

)

const

Returns the list of Records the provided Record depends on (usually none)

Definition at line 244 of file EventSetupRecordProvider.cc.

References edm::eventsetup::dependencies(), and crabWrapper::key.

Referenced by edm::eventsetup::EventSetupProvider::doRecordsMatch(), and record().

{ return dependencies(key()); }

void EventSetupRecordProvider::fillReferencedDataKeys

(

std::map< DataKey, ComponentDescription const * > &

referencedDataKeys

)

const

Definition at line 222 of file EventSetupRecordProvider.cc.

References makeMuonMisalignmentScenario::components, gen::k, relativeConstraints::keys, and record.

Referenced by edm::eventsetup::EventSetupProvider::fillReferencedDataKeys(), and finder().

                                                                                {
      std::vector<DataKey> keys;
      record().fillRegisteredDataKeys(keys);
      std::vector<ComponentDescription const*> components = record().componentsForRegisteredDataKeys();
      auto itComponents = components.begin();
      for (auto const& k : keys) {
        referencedDataKeys.emplace(k, *itComponents);
        ++itComponents;
      }
    }

std::shared_ptr<EventSetupRecordIntervalFinder const> edm::eventsetup::EventSetupRecordProvider::finder ( ) const

inline

Definition at line 101 of file EventSetupRecordProvider.h.

References finder_, and edm::get_underlying_safe().

Referenced by swapFinder().

{ return get_underlying_safe(finder_); }

std::shared_ptr<EventSetupRecordIntervalFinder>& edm::eventsetup::EventSetupRecordProvider::finder ( )

inline

Definition at line 102 of file EventSetupRecordProvider.h.

References fillReferencedDataKeys(), finder_, edm::get_underlying_safe(), getReferencedESProducers(), genParticles_cff::map, and resetRecordToProxyPointers().

{ return get_underlying_safe(finder_); }

void EventSetupRecordProvider::getReferencedESProducers

(

std::map< EventSetupRecordKey, std::vector< ComponentDescription const * >> &

referencedESProducers

)

Definition at line 217 of file EventSetupRecordProvider.cc.

References record.

Referenced by finder().

                                                                                                    {
      record().getESProducers(referencedESProducers[key_]);
    }

EventSetupRecordKey const& edm::eventsetup::EventSetupRecordProvider::key ( ) const

inline

Definition at line 55 of file EventSetupRecordProvider.h.

References key_.

{ return key_; }

EventSetupRecordProvider const& edm::eventsetup::EventSetupRecordProvider::operator= ( EventSetupRecordProvider const &  )

privatedelete

Referenced by swapFinder().

std::shared_ptr< DataProxyProvider > EventSetupRecordProvider::proxyProvider

(

ComponentDescription const &

iDesc

)

returns the first matching DataProxyProvider or a 'null' if not found

Definition at line 256 of file EventSetupRecordProvider.cc.

References edm::eventsetup::DataProxyProvider::description(), and edm::get_underlying_safe().

Referenced by edm::eventsetup::EventSetupProvider::determinePreferred(), and record().

                                                                                                              {
      using std::placeholders::_1;
      auto itFound = std::find_if(
          providers_.begin(),
          providers_.end(),
          std::bind(std::equal_to<ComponentDescription>(), iDesc, std::bind(&DataProxyProvider::description, _1)));
      if (itFound == providers_.end()) {
        return std::shared_ptr<DataProxyProvider>();
      }
      return get_underlying_safe(*itFound);
    }

std::shared_ptr< DataProxyProvider > EventSetupRecordProvider::proxyProvider

(

ParameterSetIDHolder const &

psetID

)

returns the first matching DataProxyProvider or a 'null' if not found

Definition at line 268 of file EventSetupRecordProvider.cc.

References edm::get_underlying_safe(), and edm::eventsetup::ParameterSetIDHolder::psetID().

                                                                                                               {
      for (auto& dataProxyProvider : providers_) {
        if (dataProxyProvider->description().pid_ == psetID.psetID()) {
          return get_underlying_safe(dataProxyProvider);
        }
      }
      return std::shared_ptr<DataProxyProvider>();
    }

std::set< ComponentDescription > EventSetupRecordProvider::proxyProviderDescriptions

(

)

const

return information on which DataProxyProviders are supplying information

Definition at line 246 of file EventSetupRecordProvider.cc.

References edm::eventsetup::DataProxyProvider::description(), and create_public_lumi_plots::transform.

Referenced by edm::eventsetup::EventSetupProvider::determinePreferred(), and record().

                                                                                           {
      using std::placeholders::_1;
      std::set<ComponentDescription> descriptions;
      std::transform(providers_.begin(),
                     providers_.end(),
                     std::inserter(descriptions, descriptions.end()),
                     std::bind(&DataProxyProvider::description, _1));
      return descriptions;
    }

EventSetupRecordImpl const& edm::eventsetup::EventSetupRecordProvider::record ( ) const

inline

Definition at line 57 of file EventSetupRecordProvider.h.

References record_.

{ return record_; }

EventSetupRecordImpl& edm::eventsetup::EventSetupRecordProvider::record ( )

inline

Definition at line 58 of file EventSetupRecordProvider.h.

References add(), addFinder(), addRecordTo(), addRecordToIfValid(), componentsForRegisteredDataKeys(), dependentRecords(), proxyProvider(), proxyProviderDescriptions(), record_, registeredDataKeys(), resetProxies(), resetProxyProvider(), setDependentProviders(), setValidityInterval(), setValidityIntervalFor(), and usePreferred().

{ return record_; }

std::vector< DataKey > EventSetupRecordProvider::registeredDataKeys

(

)

const

The available DataKeys in the Record. The order can be used to request the data by index.

Definition at line 286 of file EventSetupRecordProvider.cc.

Referenced by record().

                                                                          {
      std::vector<DataKey> ret;
      record_.fillRegisteredDataKeys(ret);
      return ret;
    }

void EventSetupRecordProvider::resetProxies

(

)

This will clear the cache's of all the Proxies so that next time they are called they will run.

Definition at line 207 of file EventSetupRecordProvider.cc.

References edm::for_all(), edm::eventsetup::DataProxyProvider::resetProxies(), and edm::eventsetup::DataProxyProvider::resetProxiesIfTransient().

Referenced by record(), and edm::eventsetup::EventSetupProvider::resetRecordPlusDependentRecords().

                                                {
      using std::placeholders::_1;
      cacheReset();
      for_all(providers_, std::bind(&DataProxyProvider::resetProxies, _1, key_));
      //some proxies only clear if they were accessed transiently,
      // since resetProxies resets that flag, calling resetTransients
      // will force a clear
      for_all(providers_, std::bind(&DataProxyProvider::resetProxiesIfTransient, _1, key_));
    }

void EventSetupRecordProvider::resetProxyProvider	(	ParameterSetIDHolder const &	psetID,
		std::shared_ptr< DataProxyProvider > const &	sharedDataProxyProvider
	)

Definition at line 277 of file EventSetupRecordProvider.cc.

References edm::eventsetup::ParameterSetIDHolder::psetID().

Referenced by record().

                                                                                                             {
      for (auto& dataProxyProvider : providers_) {
        if (dataProxyProvider->description().pid_ == psetID.psetID()) {
          dataProxyProvider = sharedDataProxyProvider;
        }
      }
    }

void EventSetupRecordProvider::resetRecordToProxyPointers

(

DataToPreferredProviderMap const &

iMap

)

Definition at line 234 of file EventSetupRecordProvider.cc.

References addProxiesToRecordHelper(), edm::for_all(), and record.

Referenced by finder().

                                                                                                    {
      using std::placeholders::_1;
      record().clearProxies();
      for_all(providers_, std::bind(&EventSetupRecordProvider::addProxiesToRecordHelper, this, _1, iMap));
    }

void EventSetupRecordProvider::resetTransients ( )

private

Definition at line 159 of file EventSetupRecordProvider.cc.

References edm::for_all(), and edm::eventsetup::DataProxyProvider::resetProxiesIfTransient().

Referenced by swapFinder().

                                                   {
      using std::placeholders::_1;
      if (checkResetTransients()) {
        for_all(providers_, std::bind(&DataProxyProvider::resetProxiesIfTransient, _1, key_));
      }
    }

void EventSetupRecordProvider::setDependentProviders

(

std::vector< std::shared_ptr< EventSetupRecordProvider >> const &

)

If the provided Record depends on other Records, here are the dependent Providers.

Definition at line 101 of file EventSetupRecordProvider.cc.

References crabWrapper::key, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by record().

                                                                              {
      using std::placeholders::_1;
      std::shared_ptr<DependentRecordIntervalFinder> newFinder =
          make_shared_noexcept_false<DependentRecordIntervalFinder>(key());

      std::shared_ptr<EventSetupRecordIntervalFinder> old = swapFinder(newFinder);

      for (auto const& p : iProviders) {
        newFinder->addProviderWeAreDependentOn(p);
      };
      //if a finder was already set, add it as a depedency.  This is done to ensure that the IOVs properly change even if the
      // old finder does not update each time a dependent record does change
      if (old.get() != nullptr) {
        newFinder->setAlternateFinder(old);
      }
    }

void EventSetupRecordProvider::setValidityInterval

(

ValidityInterval const &

)

Definition at line 97 of file EventSetupRecordProvider.cc.

Referenced by record().

                                                                                        {
      validityInterval_ = iInterval;
    }

bool EventSetupRecordProvider::setValidityIntervalFor

(

IOVSyncValue const &

)

sets interval to this time and returns true if have a valid interval for time

Definition at line 173 of file EventSetupRecordProvider.cc.

References edm::EventID::event(), edm::IOVSyncValue::eventID(), and edm::IOVSyncValue::invalidIOVSyncValue().

Referenced by record().

                                                                                   {
      //we want to wait until after the first event of a new run before
      // we reset any transients just in case some modules get their data at beginRun or beginLumi
      // and others wait till the first event
      if (!lastSyncWasBeginOfRun_) {
        resetTransients();
      }
      lastSyncWasBeginOfRun_ = iTime.eventID().event() == 0;

      if (validityInterval_.validFor(iTime)) {
        return true;
      }
      bool returnValue = false;
      //need to see if we get a new interval
      if (nullptr != finder_.get()) {
        IOVSyncValue oldFirst(validityInterval_.first());

        validityInterval_ = finder_->findIntervalFor(key_, iTime);
        //are we in a valid range?
        if (validityInterval_.first() != IOVSyncValue::invalidIOVSyncValue()) {
          returnValue = true;
          //did we actually change?
          if (oldFirst != validityInterval_.first()) {
            //tell all Providers to update
            for (auto& provider : providers_) {
              provider->newInterval(key_, validityInterval_);
            }
            cacheReset();
          }
        }
      }
      return returnValue;
    }

std::shared_ptr<EventSetupRecordIntervalFinder> edm::eventsetup::EventSetupRecordProvider::swapFinder ( std::shared_ptr< EventSetupRecordIntervalFinder >  iNew )

inlineprotected

Definition at line 119 of file EventSetupRecordProvider.h.

References checkResetTransients(), EventSetupRecordProvider(), finder(), operator=(), resetTransients(), and std::swap().

                                                                                                                   {
        std::swap(iNew, finder());
        return iNew;
      }

void EventSetupRecordProvider::usePreferred

(

DataToPreferredProviderMap const &

)

In the case of a conflict, sets what Provider to call. This must be called after all providers have been added. An empty map is acceptable.

Definition at line 118 of file EventSetupRecordProvider.cc.

References addProxiesToRecordHelper(), and edm::for_all().

Referenced by record().

                                                                                      {
      using std::placeholders::_1;
      for_all(providers_, std::bind(&EventSetupRecordProvider::addProxiesToRecordHelper, this, _1, iMap));
      if (1 < multipleFinders_->size()) {
        std::shared_ptr<IntersectingIOVRecordIntervalFinder> intFinder =
            make_shared_noexcept_false<IntersectingIOVRecordIntervalFinder>(key_);
        intFinder->swapFinders(*multipleFinders_);
        finder_ = intFinder;
      }
      //now we get rid of the temporary
      multipleFinders_.reset(nullptr);
    }

ValidityInterval const& edm::eventsetup::EventSetupRecordProvider::validityInterval ( ) const

inline

Definition at line 54 of file EventSetupRecordProvider.h.

References validityInterval_.

{ return validityInterval_; }

Member Data Documentation

edm::propagate_const<std::shared_ptr<EventSetupRecordIntervalFinder> > edm::eventsetup::EventSetupRecordProvider::finder_

private

Definition at line 135 of file EventSetupRecordProvider.h.

Referenced by finder().

EventSetupRecordKey const edm::eventsetup::EventSetupRecordProvider::key_

private

Definition at line 133 of file EventSetupRecordProvider.h.

Referenced by key().

bool edm::eventsetup::EventSetupRecordProvider::lastSyncWasBeginOfRun_

private

Definition at line 139 of file EventSetupRecordProvider.h.

std::unique_ptr<std::vector<edm::propagate_const<std::shared_ptr<EventSetupRecordIntervalFinder> > > > edm::eventsetup::EventSetupRecordProvider::multipleFinders_

private

Definition at line 138 of file EventSetupRecordProvider.h.

std::vector<edm::propagate_const<std::shared_ptr<DataProxyProvider> > > edm::eventsetup::EventSetupRecordProvider::providers_

private

Definition at line 136 of file EventSetupRecordProvider.h.

EventSetupRecordImpl edm::eventsetup::EventSetupRecordProvider::record_

private

Definition at line 132 of file EventSetupRecordProvider.h.

Referenced by record().

ValidityInterval edm::eventsetup::EventSetupRecordProvider::validityInterval_

private

Definition at line 134 of file EventSetupRecordProvider.h.

Referenced by validityInterval().