edm::eventsetup::EventSetupRecordImpl Class Reference

#include <EventSetupRecordImpl.h>

Public Member Functions
bool	add (DataKey const &iKey, DataProxy const *iProxy)
void	addTraceInfoToCmsException (cms::Exception &iException, char const *iName, ComponentDescription const *, DataKey const &) const
unsigned long long	cacheIdentifier () const
void	cacheReset ()
void	changeStdExceptionToCmsException (char const *iExceptionWhatMessage, char const *iName, ComponentDescription const *, DataKey const &) const
void	clearProxies ()
std::vector< ComponentDescription const * >	componentsForRegisteredDataKeys () const
	there is a 1-to-1 correspondence between elements returned and the elements returned from fillRegisteredDataKey. More...
bool	doGet (DataKey const &aKey, bool aGetTransiently=false) const
	returns false if no data available for key More...
EventSetupImpl const &	eventSetup () const
	EventSetupRecordImpl (const EventSetupRecordKey &iKey)
void	fillRegisteredDataKeys (std::vector< DataKey > &oToFill) const
	clears the oToFill vector and then fills it with the keys for all registered data keys More...
DataProxy const *	find (DataKey const &aKey) const
void	getESProducers (std::vector< ComponentDescription const * > &esproducers)
EventSetupRecordKey const &	key () const
ComponentDescription const *	providerDescription (DataKey const &aKey) const
void	set (ValidityInterval const &)
void	setEventSetup (EventSetupImpl const *iEventSetup)
void	transientAccessRequested () const
bool	transientReset ()
	returns 'true' if a transient request has occurred since the last call to transientReset. More...
void	validate (ComponentDescription const *, ESInputTag const &) const
ValidityInterval const &	validityInterval () const
bool	wasGotten (DataKey const &aKey) const

Private Member Functions
	EventSetupRecordImpl (EventSetupRecordImpl const &)=delete
void const *	getFromProxy (DataKey const &iKey, ComponentDescription const *&iDesc, bool iTransientAccessOnly) const
void const *	getFromProxy (ESProxyIndex iProxyIndex, bool iTransientAccessOnly, ComponentDescription const *&iDesc, DataKey const *&oGottenKey) const
template<typename DataT >
void	getImplementation (DataT const *&iData, char const *iName, ComponentDescription const *&iDesc, bool iTransientAccessOnly, std::shared_ptr< ESHandleExceptionFactory > &whyFailedFactory) const
template<typename DataT >
void	getImplementation (DataT const *&iData, ESProxyIndex iProxyIndex, bool iTransientAccessOnly, ComponentDescription const *&oDesc, std::shared_ptr< ESHandleExceptionFactory > &whyFailedFactory) const
EventSetupRecordImpl const &	operator= (EventSetupRecordImpl const &)=delete

Private Attributes
unsigned long long	cacheIdentifier_
EventSetupImpl const *	eventSetup_
EventSetupRecordKey	key_
std::vector< DataKey >	keysForProxies_
std::vector< DataProxy const * >	proxies_
std::atomic< bool >	transientAccessRequested_
ValidityInterval	validity_

Friends
class	EventSetupRecord

Detailed Description

Definition at line 83 of file EventSetupRecordImpl.h.

Constructor & Destructor Documentation

edm::eventsetup::EventSetupRecordImpl::EventSetupRecordImpl

(

const EventSetupRecordKey &

iKey

)

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

privatedelete

Member Function Documentation

bool EventSetupRecordImpl::add	(	DataKey const &	iKey,
		DataProxy const *	iProxy
	)

Definition at line 74 of file EventSetupRecordImpl.cc.

References SoftLeptonByDistance_cfi::distance, Exception, edm::eventsetup::EventSetupRecord::find(), edm::eventsetup::ComponentDescription::isLooper_, edm::eventsetup::ComponentDescription::isSource_, edm::eventsetup::EventSetupRecord::key(), edm::eventsetup::ComponentDescription::label_, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, edm::eventsetup::heterocontainer::HCTypeTag::name(), edm::eventsetup::DataKey::name(), edm::eventsetup::DataProxy::providerDescription(), edm::eventsetup::EventSetupRecordKey::type(), edm::eventsetup::DataKey::type(), edm::eventsetup::ComponentDescription::type_, and edm::eventsetup::SimpleStringTag::value().

Referenced by counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

                                                                               {
      //
      const DataProxy* proxy = find(iKey);
      if (nullptr != proxy) {
        //
        // we already know the field exist, so do not need to check against end()
        //

        // POLICY: If a Producer and a Source both claim to deliver the same data, the
        //  Producer 'trumps' the Source. If two modules of the same type claim to deliver the
        //  same data, this is an error unless the configuration specifically states which one
        //  is to be chosen.  A Looper trumps both a Producer and a Source.

        assert(proxy->providerDescription());
        assert(iProxy->providerDescription());
        if (iProxy->providerDescription()->isLooper_) {
          proxies_[std::distance(keysForProxies_.begin(),
                                 std::lower_bound(keysForProxies_.begin(), keysForProxies_.end(), iKey))] = iProxy;
          return true;
        }

        if (proxy->providerDescription()->isSource_ == iProxy->providerDescription()->isSource_) {
          //should lookup to see if there is a specified 'chosen' one and only if not, throw the exception
          throw cms::Exception("EventSetupConflict")
              << "two EventSetup " << (proxy->providerDescription()->isSource_ ? "Sources" : "Producers")
              << " want to deliver type=\"" << iKey.type().name() << "\" label=\"" << iKey.name().value() << "\"\n"
              << " from record " << key().type().name() << ". The two providers are \n"
              << "1) type=\"" << proxy->providerDescription()->type_ << "\" label=\""
              << proxy->providerDescription()->label_ << "\"\n"
              << "2) type=\"" << iProxy->providerDescription()->type_ << "\" label=\""
              << iProxy->providerDescription()->label_ << "\"\n"
              << "Please either\n   remove one of these "
              << (proxy->providerDescription()->isSource_ ? "Sources" : "Producers")
              << "\n   or find a way of configuring one of them so it does not deliver this data"
              << "\n   or use an es_prefer statement in the configuration to choose one.";
        } else if (proxy->providerDescription()->isSource_) {
          proxies_[std::distance(keysForProxies_.begin(),
                                 std::lower_bound(keysForProxies_.begin(), keysForProxies_.end(), iKey))] = iProxy;
        } else {
          return false;
        }
      } else {
        auto lb = std::lower_bound(keysForProxies_.begin(), keysForProxies_.end(), iKey);
        auto index = std::distance(keysForProxies_.begin(), lb);
        keysForProxies_.insert(lb, iKey);
        proxies_.insert(proxies_.begin() + index, iProxy);
      }
      return true;
    }

void EventSetupRecordImpl::addTraceInfoToCmsException	(	cms::Exception &	iException,
		char const *	iName,
		ComponentDescription const *	,
		DataKey const &
	)		const

Definition at line 267 of file EventSetupRecordImpl.cc.

References cms::Exception::addContext(), edm::eventsetup::EventSetupRecord::key(), edm::eventsetup::ComponentDescription::label_, edm::eventsetup::heterocontainer::HCTypeTag::name(), edm::eventsetup::EventSetupRecordKey::type(), edm::eventsetup::DataKey::type(), and edm::eventsetup::ComponentDescription::type_.

                                                                                     {
      std::ostringstream ost;
      ost << "Using EventSetup component " << iDescription->type_ << "/'" << iDescription->label_ << "' to make data "
          << iKey.type().name() << "/'" << iName << "' in record " << this->key().type().name();
      iException.addContext(ost.str());
    }

unsigned long long edm::eventsetup::EventSetupRecordImpl::cacheIdentifier ( ) const

inline

If you are caching data from the Record, you should also keep this number. If this number changes then you know that the data you have cached is invalid. This is NOT true if if the validityInterval() hasn't changed since it is possible that the job has gone to a new Record and then come back to the previous SyncValue and your algorithm didn't see the intervening Record. The value of '0' will never be returned so you can use that to denote that you have not yet checked the value.

Definition at line 118 of file EventSetupRecordImpl.h.

References PVValHelper::add().

{ return cacheIdentifier_; }

void EventSetupRecordImpl::cacheReset

(

)

Definition at line 129 of file EventSetupRecordImpl.cc.

                                          {
      transientAccessRequested_ = false;
      ++cacheIdentifier_;
    }

void edm::eventsetup::EventSetupRecordImpl::changeStdExceptionToCmsException	(	char const *	iExceptionWhatMessage,
		char const *	iName,
		ComponentDescription const *	,
		DataKey const &
	)		const

void EventSetupRecordImpl::clearProxies

(

)

Definition at line 124 of file EventSetupRecordImpl.cc.

                                            {
      keysForProxies_.clear();
      proxies_.clear();
    }

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

(

)

const

there is a 1-to-1 correspondence between elements returned and the elements returned from fillRegisteredDataKey.

Definition at line 65 of file EventSetupRecordImpl.cc.

                                                                                                       {
      std::vector<ComponentDescription const*> ret;
      ret.reserve(proxies_.size());
      for (auto const& proxy : proxies_) {
        ret.push_back(proxy->providerDescription());
      }
      return ret;
    }

bool EventSetupRecordImpl::doGet	(	DataKey const &	aKey,
		bool	aGetTransiently = false
	)		const

returns false if no data available for key

Definition at line 210 of file EventSetupRecordImpl.cc.

References edm::eventsetup::EventSetupRecord::addTraceInfoToCmsException(), edm::eventsetup::DataProxy::doGet(), MillePedeFileConverter_cfg::e, edm::eventsetup::EventSetupRecord::find(), edm::eventsetup::DataKey::name(), edm::eventsetup::DataProxy::providerDescription(), edm::eventsetup::SimpleStringTag::value(), and edm::convertException::wrap().

Referenced by edm::eventsetup::EventSetupRecord::doGet().

                                                                                    {
      const DataProxy* proxy = find(aKey);
      if (nullptr != proxy) {
        try {
          convertException::wrap(
              [&]() { proxy->doGet(*this, aKey, aGetTransiently, eventSetup_->activityRegistry()); });
        } catch (cms::Exception& e) {
          addTraceInfoToCmsException(e, aKey.name().value(), proxy->providerDescription(), aKey);
          //NOTE: the above function can't do the 'throw' since it causes the C++ class type
          // of the throw to be changed, a 'rethrow' does not have that problem
          throw;
        }
      }
      return nullptr != proxy;
    }

EventSetupImpl const& edm::eventsetup::EventSetupRecordImpl::eventSetup ( ) const

inline

Definition at line 143 of file EventSetupRecordImpl.h.

{ return *eventSetup_; }

void EventSetupRecordImpl::fillRegisteredDataKeys

(

std::vector< DataKey > &

oToFill

)

const

clears the oToFill vector and then fills it with the keys for all registered data keys

Definition at line 242 of file EventSetupRecordImpl.cc.

                                                                                       {
      oToFill = keysForProxies_;
    }

const DataProxy * EventSetupRecordImpl::find

(

DataKey const &

aKey

)

const

Definition at line 202 of file EventSetupRecordImpl.cc.

References SoftLeptonByDistance_cfi::distance, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, and or.

                                                                         {
      auto lb = std::lower_bound(keysForProxies_.begin(), keysForProxies_.end(), iKey);
      if ((lb == keysForProxies_.end()) or (*lb != iKey)) {
        return nullptr;
      }
      return proxies_[std::distance(keysForProxies_.begin(), lb)];
    }

void EventSetupRecordImpl::getESProducers

(

std::vector< ComponentDescription const * > &

esproducers

)

Definition at line 54 of file EventSetupRecordImpl.cc.

References edm::eventsetup::ComponentDescription::isLooper_, and edm::eventsetup::ComponentDescription::isSource_.

                                                                                                 {
      esproducers.clear();
      esproducers.reserve(proxies_.size());
      for (auto const& iData : proxies_) {
        ComponentDescription const* componentDescription = iData->providerDescription();
        if (!componentDescription->isLooper_ && !componentDescription->isSource_) {
          esproducers.push_back(componentDescription);
        }
      }
    }

void const* edm::eventsetup::EventSetupRecordImpl::getFromProxy ( DataKey const &  iKey, ComponentDescription const *&  iDesc, bool  iTransientAccessOnly  ) const

private

Referenced by transientReset().

void const* edm::eventsetup::EventSetupRecordImpl::getFromProxy ( ESProxyIndex  iProxyIndex, bool  iTransientAccessOnly, ComponentDescription const *&  iDesc, DataKey const *&  oGottenKey  ) const

private

template<typename DataT >

void edm::eventsetup::EventSetupRecordImpl::getImplementation ( DataT const *&  iData, char const *  iName, ComponentDescription const *&  iDesc, bool  iTransientAccessOnly, std::shared_ptr< ESHandleExceptionFactory > &  whyFailedFactory  ) const

inlineprivate

Definition at line 173 of file EventSetupRecordImpl.h.

References crabWrapper::key, and edm::makeESHandleExceptionFactory().

                                                                                              {
        DataKey dataKey(DataKey::makeTypeTag<DataT>(), iName, DataKey::kDoNotCopyMemory);

        void const* pValue = this->getFromProxy(dataKey, iDesc, iTransientAccessOnly);
        if (nullptr == pValue) {
          whyFailedFactory = makeESHandleExceptionFactory([=] {
            NoProxyException<DataT> ex(this->key(), dataKey);
            return std::make_exception_ptr(ex);
          });
        }
        iData = reinterpret_cast<DataT const*>(pValue);
      }

template<typename DataT >

void edm::eventsetup::EventSetupRecordImpl::getImplementation ( DataT const *&  iData, ESProxyIndex  iProxyIndex, bool  iTransientAccessOnly, ComponentDescription const *&  oDesc, std::shared_ptr< ESHandleExceptionFactory > &  whyFailedFactory  ) const

inlineprivate

Definition at line 191 of file EventSetupRecordImpl.h.

References crabWrapper::key, edm::makeESHandleExceptionFactory(), SiStripPI::max, and edm::ESProxyIndex::value().

                                                                                              {
        DataKey const* dataKey = nullptr;
        if (iProxyIndex.value() == std::numeric_limits<int>::max()) {
          whyFailedFactory = makeESHandleExceptionFactory([=] {
            NoProxyException<DataT> ex(this->key(), {});
            return std::make_exception_ptr(ex);
          });
          iData = nullptr;
          return;
        }
        assert(iProxyIndex.value() > -1 and
               iProxyIndex.value() < static_cast<ESProxyIndex::Value_t>(keysForProxies_.size()));
        void const* pValue = this->getFromProxy(iProxyIndex, iTransientAccessOnly, oDesc, dataKey);
        if (nullptr == pValue) {
          whyFailedFactory = makeESHandleExceptionFactory([=] {
            NoProxyException<DataT> ex(this->key(), *dataKey);
            return std::make_exception_ptr(ex);
          });
        }
        iData = reinterpret_cast<DataT const*>(pValue);
      }

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

inline

Definition at line 106 of file EventSetupRecordImpl.h.

Referenced by edm::EventSetupImpl::add(), edm::eventsetup::DataProxyTemplate< RecordT, DataT >::getImpl(), edm::eventsetup::CallbackProxy< CallbackT, RecordT, DataT >::getImpl(), and edm::eventsetup::DataProxy::invalidateTransientCache().

{ return key_; }

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

privatedelete

edm::eventsetup::ComponentDescription const * EventSetupRecordImpl::providerDescription

(

DataKey const &

aKey

)

const

returns the ComponentDescription for the module which creates the data or 0 if no module has been registered for the data. This does not cause the data to actually be constructed.

Definition at line 234 of file EventSetupRecordImpl.cc.

References edm::eventsetup::EventSetupRecord::find(), and edm::eventsetup::DataProxy::providerDescription().

Referenced by edm::eventsetup::EventSetupRecord::providerDescription().

                                                                                                                {
      const DataProxy* proxy = find(aKey);
      if (nullptr != proxy) {
        return proxy->providerDescription();
      }
      return nullptr;
    }

void EventSetupRecordImpl::set

(

ValidityInterval const &

)

Definition at line 52 of file EventSetupRecordImpl.cc.

{ validity_ = iInterval; }

void edm::eventsetup::EventSetupRecordImpl::setEventSetup ( EventSetupImpl const *  iEventSetup )

inline

Definition at line 136 of file EventSetupRecordImpl.h.

References spr::find().

Referenced by edm::eventsetup::EventSetupProvider::addRecordToEventSetup().

{ eventSetup_ = iEventSetup; }

void edm::eventsetup::EventSetupRecordImpl::transientAccessRequested ( ) const

inline

Definition at line 156 of file EventSetupRecordImpl.h.

{ transientAccessRequested_ = true; }

bool EventSetupRecordImpl::transientReset

(

)

returns 'true' if a transient request has occurred since the last call to transientReset.

Definition at line 134 of file EventSetupRecordImpl.cc.

References edm::eventsetup::EventSetupRecord::addTraceInfoToCmsException(), MillePedeFileConverter_cfg::e, edm::eventsetup::EventSetupRecord::find(), edm::eventsetup::DataProxy::get(), getFromProxy(), edm::eventsetup::EventSetupRecord::key(), edm::eventsetup::EventSetupRecordKey::name(), edm::eventsetup::DataKey::name(), edm::eventsetup::DataProxy::providerDescription(), edm::eventsetup::SimpleStringTag::value(), edm::ESProxyIndex::value(), and edm::convertException::wrap().

                                              {
      bool returnValue = transientAccessRequested_;
      transientAccessRequested_ = false;
      return returnValue;
    }

void EventSetupRecordImpl::validate	(	ComponentDescription const *	,
		ESInputTag const &
	)		const

Definition at line 246 of file EventSetupRecordImpl.cc.

References edm::ESInputTag::data(), Exception, edm::eventsetup::ComponentDescription::label_, electrons_cff::matched, edm::ESInputTag::module(), and edm::eventsetup::ComponentDescription::type_.

                                                                                                       {
      if (iDesc && !iTag.module().empty()) {
        bool matched = false;
        if (iDesc->label_.empty()) {
          matched = iDesc->type_ == iTag.module();
        } else {
          matched = iDesc->label_ == iTag.module();
        }
        if (!matched) {
          throw cms::Exception("EventSetupWrongModule")
              << "EventSetup data was retrieved using an ESInputTag with the values\n"
              << "  moduleLabel = '" << iTag.module() << "'\n"
              << "  dataLabel = '" << iTag.data() << "'\n"
              << "but the data matching the C++ class type and dataLabel comes from module type=" << iDesc->type_
              << " label='" << iDesc->label_ << "'.\n Please either change the ESInputTag's 'module' label to be "
              << (iDesc->label_.empty() ? iDesc->type_ : iDesc->label_) << "\n or add the EventSetup module "
              << iTag.module() << " to the configuration.";
        }
      }
    }

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

inline

Definition at line 90 of file EventSetupRecordImpl.h.

{ return validity_; }

bool EventSetupRecordImpl::wasGotten

(

DataKey const &

aKey

)

const

returns true only if someone has already requested data for this key and the data was retrieved

Definition at line 226 of file EventSetupRecordImpl.cc.

References edm::eventsetup::DataProxy::cacheIsValid(), and edm::eventsetup::EventSetupRecord::find().

Referenced by edm::eventsetup::EventSetupRecord::wasGotten().

                                                                  {
      const DataProxy* proxy = find(aKey);
      if (nullptr != proxy) {
        return proxy->cacheIsValid();
      }
      return false;
    }

Friends And Related Function Documentation

friend class EventSetupRecord

friend

Definition at line 84 of file EventSetupRecordImpl.h.

Member Data Documentation

unsigned long long edm::eventsetup::EventSetupRecordImpl::cacheIdentifier_

private

Definition at line 223 of file EventSetupRecordImpl.h.

EventSetupImpl const* edm::eventsetup::EventSetupRecordImpl::eventSetup_

private

Definition at line 222 of file EventSetupRecordImpl.h.

EventSetupRecordKey edm::eventsetup::EventSetupRecordImpl::key_

private

Definition at line 219 of file EventSetupRecordImpl.h.

std::vector<DataKey> edm::eventsetup::EventSetupRecordImpl::keysForProxies_

private

Definition at line 220 of file EventSetupRecordImpl.h.

std::vector<DataProxy const*> edm::eventsetup::EventSetupRecordImpl::proxies_

private

Definition at line 221 of file EventSetupRecordImpl.h.

std::atomic<bool> edm::eventsetup::EventSetupRecordImpl::transientAccessRequested_

mutableprivate

Definition at line 224 of file EventSetupRecordImpl.h.

ValidityInterval edm::eventsetup::EventSetupRecordImpl::validity_

private

Definition at line 218 of file EventSetupRecordImpl.h.