#include <EventSetupRecord.h>

Inheritance diagram for edm::eventsetup::EventSetupRecord:

Public Member Functions
unsigned long long	cacheIdentifier () const

bool	doGet (DataKey const &aKey, bool aGetTransiently=false) const
	returns false if no data available for key More...

	EventSetupRecord ()

	EventSetupRecord (EventSetupRecord &&)=default

	EventSetupRecord (EventSetupRecord const &)=default

void	fillRegisteredDataKeys (std::vector< DataKey > &oToFill) const
	clears the oToFill vector and then fills it with the keys for all registered data keys More...

template<typename HolderT >
bool	get (HolderT &iHolder) const

template<typename HolderT >
bool	get (char const *iName, HolderT &iHolder) const

template<typename HolderT >
bool	get (std::string const &iName, HolderT &iHolder) const

template<typename HolderT >
bool	get (ESInputTag const &iTag, HolderT &iHolder) const

virtual EventSetupRecordKey	key () const =0

EventSetupRecord &	operator= (EventSetupRecord &&)=default

EventSetupRecord &	operator= (EventSetupRecord const &)=default

ComponentDescription const *	providerDescription (DataKey const &aKey) const

void	setImpl (EventSetupRecordImpl const iImpl, unsigned int transitionID, ESProxyIndex const getTokenIndices)

ValidityInterval const &	validityInterval () const

bool	wasGotten (DataKey const &aKey) const

virtual	~EventSetupRecord ()

Protected Member Functions
void	addTraceInfoToCmsException (cms::Exception &iException, char const iName, ComponentDescription const , DataKey const &) const

void	changeStdExceptionToCmsException (char const iExceptionWhatMessage, char const iName, ComponentDescription const *, DataKey const &) const

EventSetupImpl const &	eventSetup () const

DataProxy const *	find (DataKey const &aKey) const

template<template< typename > typename H, typename T , typename R >
H< T >	getHandleImpl (ESGetToken< T, R > const &iToken) const

ESProxyIndex const *	getTokenIndices () const

EventSetupRecordImpl const *	impl () const

unsigned int	transitionID () const

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

Private Member Functions
void const *	getFromProxy (DataKey const &iKey, ComponentDescription const *&iDesc, bool iTransientAccessOnly) const

template<template< typename > typename H, typename T , typename R >
H< T >	invalidTokenHandle (ESGetToken< T, R > const &iToken) const

template<template< typename > typename H, typename T , typename R >
H< T >	noProxyHandle (ESGetToken< T, R > const &iToken) const

Static Private Member Functions
static std::exception_ptr	makeInvalidTokenException (EventSetupRecordKey const &, TypeTag const &)

Private Attributes
ESProxyIndex const *	getTokenIndices_ = 0

EventSetupRecordImpl const *	impl_ = 0

unsigned int	transitionID_ = std::numeric_limits<unsigned int>::max()

Friends
class	::testEventsetup

class	::testEventsetupRecord

Detailed Description

Definition at line 91 of file EventSetupRecord.h.

Constructor & Destructor Documentation

EventSetupRecord::EventSetupRecord ( )

Definition at line 41 of file EventSetupRecord.cc.

41 {}

edm::eventsetup::EventSetupRecord::EventSetupRecord ( EventSetupRecord && )

default

edm::eventsetup::EventSetupRecord::EventSetupRecord ( EventSetupRecord const & )

default

EventSetupRecord::~EventSetupRecord ( )

virtual

Definition at line 48 of file EventSetupRecord.cc.

48 {}

Member Function Documentation

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

protected

Definition at line 100 of file EventSetupRecord.cc.

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

Referenced by edm::eventsetup::EventSetupRecordImpl::doGet(), and edm::eventsetup::EventSetupRecordImpl::transientReset().

                                                                                  {
       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::EventSetupRecord::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 181 of file EventSetupRecord.h.

Referenced by L1TCSCTF::analyze(), AngleConverter::checkAndUpdateGeometry(), L1TMuon::TTGeometryTranslator::checkAndUpdateGeometry(), L1TMuon::GeometryTranslator::checkAndUpdateGeometry(), DeepFlavourTagInfoProducer::checkEventSetup(), IPProducer< Container, Base, Helper >::checkEventSetup(), GsfElectronAlgo::checkSetup(), TrajSeedMatcher::doEventSetup(), HLTMuonPointingFilter::filter(), CSCTFTrackProducer::produce(), cms::JetCorrectionProducer< T >::produce(), EcalTrigPrimProducer::produce(), PFBadHcalPseudoClusterProducer::produce(), ElectronSeedProducer::produce(), RPCTrigger::produce(), EgammaHLTGsfTrackVarProducer::TrackExtrapolator::setup(), TrackingRecHitProducer::setupDetIdPipes(), EgammaHLTPixelMatchElectronAlgo::setupES(), ElectronSeedGenerator::setupES(), SiStripElectronSeedGenerator::setupES(), SCRegressionCalculator< VarCalc >::update(), BaselinePFSCRegression::update(), fastsim::Geometry::update(), and DTTrig::updateES().

181 { return impl_->cacheIdentifier(); }

edm::eventsetup::EventSetupRecordImpl::cacheIdentifier

unsigned long long cacheIdentifier() const

Definition: EventSetupRecordImpl.h:118

edm::eventsetup::EventSetupRecord::impl_

EventSetupRecordImpl const * impl_

Definition: EventSetupRecord.h:255

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

protected

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

returns false if no data available for key

Definition at line 69 of file EventSetupRecord.cc.

References edm::eventsetup::EventSetupRecordImpl::doGet(), and impl_.

                                                                                 {
       return impl_->doGet(aKey, aGetTransiently);
     }

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

inlineprotected

Definition at line 212 of file EventSetupRecord.h.

Referenced by edm::eventsetup::DependentRecordImplementation< EcalLaserDbRecord, boost::mpl::vector< EcalLaserAlphasRcd, EcalLaserAPDPNRatiosRefRcd, EcalLaserAPDPNRatiosRcd, EcalLinearCorrectionsRcd > >::getRecord(), and edm::eventsetup::DependentRecordImplementation< EcalLaserDbRecord, boost::mpl::vector< EcalLaserAlphasRcd, EcalLaserAPDPNRatiosRefRcd, EcalLaserAPDPNRatiosRcd, EcalLinearCorrectionsRcd > >::tryToGetRecord().

212 { return impl_->eventSetup(); }

edm::eventsetup::EventSetupRecordImpl::eventSetup

EventSetupImpl const & eventSetup() const

Definition: EventSetupRecordImpl.h:143

edm::eventsetup::EventSetupRecord::impl_

EventSetupRecordImpl const * impl_

Definition: EventSetupRecord.h:255

void edm::eventsetup::EventSetupRecord::fillRegisteredDataKeys ( std::vector< DataKey > & oToFill ) const

inline

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

Definition at line 184 of file EventSetupRecord.h.

References class-composition::H, and dttmaxenums::R.

184 { impl_->fillRegisteredDataKeys(oToFill); }

edm::eventsetup::EventSetupRecordImpl::fillRegisteredDataKeys

void fillRegisteredDataKeys(std::vector< DataKey > &oToFill) const

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

Definition: EventSetupRecordImpl.cc:242

edm::eventsetup::EventSetupRecord::impl_

EventSetupRecordImpl const * impl_

Definition: EventSetupRecord.h:255

DataProxy const* edm::eventsetup::EventSetupRecord::find ( DataKey const & aKey ) const

protected

Referenced by edm::eventsetup::EventSetupRecordImpl::add(), edm::eventsetup::EventSetupRecordImpl::doGet(), edm::eventsetup::EventSetupRecordImpl::providerDescription(), edm::eventsetup::EventSetupRecordImpl::transientReset(), and edm::eventsetup::EventSetupRecordImpl::wasGotten().

template<typename HolderT >

bool edm::eventsetup::EventSetupRecord::get ( HolderT & iHolder ) const

inline

template<typename HolderT >

bool edm::eventsetup::EventSetupRecord::get	(	char const *	iName,
		HolderT &	iHolder
	)		const

inline

Definition at line 119 of file EventSetupRecord.h.

References eostools::move().

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

                                                           {
         typename HolderT::value_type const* value = nullptr;
         ComponentDescription const* desc = nullptr;
         std::shared_ptr<ESHandleExceptionFactory> whyFailedFactory;
         impl_->getImplementation(value, iName, desc, iHolder.transientAccessOnly, whyFailedFactory);
 
         if (value) {
           iHolder = HolderT(value, desc);
           return true;
         } else {
           iHolder = HolderT(std::move(whyFailedFactory));
           return false;
         }
       }

template<typename HolderT >

bool edm::eventsetup::EventSetupRecord::get	(	std::string const &	iName,
		HolderT &	iHolder
	)		const

inline

Definition at line 134 of file EventSetupRecord.h.

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

                                                                {
         return get(iName.c_str(), iHolder);
       }

template<typename HolderT >

bool edm::eventsetup::EventSetupRecord::get	(	ESInputTag const &	iTag,
		HolderT &	iHolder
	)		const

inline

Definition at line 139 of file EventSetupRecord.h.

References crabWrapper::key, and eostools::move().

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

                                                                {
         typename HolderT::value_type const* value = nullptr;
         ComponentDescription const* desc = nullptr;
         std::shared_ptr<ESHandleExceptionFactory> whyFailedFactory;
         impl_->getImplementation(value, iTag.data().c_str(), desc, iHolder.transientAccessOnly, whyFailedFactory);
 
         if (value) {
           validate(desc, iTag);
           iHolder = HolderT(value, desc);
           return true;
         } else {
           iHolder = HolderT(std::move(whyFailedFactory));
           return false;
         }
       }

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

private

template<template< typename > typename H, typename T , typename R >

H<T> edm::eventsetup::EventSetupRecord::getHandleImpl ( ESGetToken< T, R > const & iToken ) const

inlineprotected

Definition at line 188 of file EventSetupRecord.h.

References spr::find(), edm::ESGetToken< ESProduct, ESRecord >::hasValidIndex(), edm::ESGetToken< ESProduct, ESRecord >::index(), edm::ESGetToken< ESProduct, ESRecord >::isInitialized(), SiStripPI::max, eostools::move(), edm::ESGetToken< ESProduct, ESRecord >::transitionID(), UNLIKELY, and relativeConstraints::value.

                                                                {
         assert(iToken.transitionID() == transitionID());
         assert(iToken.isInitialized());
         assert(getTokenIndices_);
         //need to check token has valid index
         if
           UNLIKELY(not iToken.hasValidIndex()) { return invalidTokenHandle<H>(iToken); }
 
         auto proxyIndex = getTokenIndices_[iToken.index().value()];
         if
           UNLIKELY(proxyIndex.value() == std::numeric_limits<int>::max()) { return noProxyHandle<H>(iToken); }
 
         T const* value = nullptr;
         ComponentDescription const* desc = nullptr;
         std::shared_ptr<ESHandleExceptionFactory> whyFailedFactory;
         impl_->getImplementation(value, proxyIndex, H<T>::transientAccessOnly, desc, whyFailedFactory);
 
         if
           UNLIKELY(not value) { return H<T>(std::move(whyFailedFactory)); }
         return H<T>(value, desc);
       }

ESProxyIndex const* edm::eventsetup::EventSetupRecord::getTokenIndices ( ) const

inlineprotected

Definition at line 214 of file EventSetupRecord.h.

Referenced by edm::eventsetup::DependentRecordImplementation< EcalLaserDbRecord, boost::mpl::vector< EcalLaserAlphasRcd, EcalLaserAPDPNRatiosRefRcd, EcalLaserAPDPNRatiosRcd, EcalLinearCorrectionsRcd > >::getRecord(), and edm::eventsetup::DependentRecordImplementation< EcalLaserDbRecord, boost::mpl::vector< EcalLaserAlphasRcd, EcalLaserAPDPNRatiosRefRcd, EcalLaserAPDPNRatiosRcd, EcalLinearCorrectionsRcd > >::tryToGetRecord().

214 { return getTokenIndices_; }

edm::eventsetup::EventSetupRecord::getTokenIndices_

ESProxyIndex const * getTokenIndices_

Definition: EventSetupRecord.h:256

EventSetupRecordImpl const* edm::eventsetup::EventSetupRecord::impl ( ) const

inlineprotected

Definition at line 227 of file EventSetupRecord.h.

227 { return impl_; }

edm::eventsetup::EventSetupRecord::impl_

EventSetupRecordImpl const * impl_

Definition: EventSetupRecord.h:255

template<template< typename > typename H, typename T , typename R >

H<T> edm::eventsetup::EventSetupRecord::invalidTokenHandle ( ESGetToken< T, R > const & iToken ) const

inlineprivate

Definition at line 233 of file EventSetupRecord.h.

References class-composition::H, crabWrapper::key, edm::makeESHandleExceptionFactory(), and dttmaxenums::R.

                                                                     {
         auto const key = this->key();
         return H<T>{
             makeESHandleExceptionFactory([key] { return makeInvalidTokenException(key, DataKey::makeTypeTag<T>()); })};
       }

virtual EventSetupRecordKey edm::eventsetup::EventSetupRecord::key ( ) const

pure virtual

Referenced by edm::eventsetup::EventSetupRecordImpl::add(), edm::eventsetup::EventSetupRecordImpl::addTraceInfoToCmsException(), addTraceInfoToCmsException(), and edm::eventsetup::EventSetupRecordImpl::transientReset().

std::exception_ptr EventSetupRecord::makeInvalidTokenException	(	EventSetupRecordKey const &	iRecordKey,
		TypeTag const &	iDataKey
	)

staticprivate

Definition at line 110 of file EventSetupRecord.cc.

References edm::eventsetup::heterocontainer::HCTypeTag::name(), and edm::eventsetup::EventSetupRecordKey::name().

                                                                                             {
       cms::Exception ex("InvalidESGetToken");
       ex << "Attempted to get data using an invalid token of type ESGetToken<" << iDataKey.name() << ","
          << iRecordKey.name()
          << ">.\n"
             "Please call consumes to properly initialize the token.";
       return std::make_exception_ptr(ex);
     }

template<template< typename > typename H, typename T , typename R >

H<T> edm::eventsetup::EventSetupRecord::noProxyHandle ( ESGetToken< T, R > const & iToken ) const

inlineprivate

Definition at line 240 of file EventSetupRecord.h.

References crabWrapper::key, edm::makeESHandleExceptionFactory(), dataset::name, and edm::ESGetToken< ESProduct, ESRecord >::name().

                                                                {
         auto const key = this->key();
         auto name = iToken.name();
         return H<T>{makeESHandleExceptionFactory([key, name] {
           NoProxyException<T> ex(key, DataKey{DataKey::makeTypeTag<T>(), name});
           return std::make_exception_ptr(ex);
         })};
       }

EventSetupRecord& edm::eventsetup::EventSetupRecord::operator= ( EventSetupRecord && )

default

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

default

edm::eventsetup::ComponentDescription const * EventSetupRecord::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 75 of file EventSetupRecord.cc.

References impl_, and edm::eventsetup::EventSetupRecordImpl::providerDescription().

                                                                                                             {
       return impl_->providerDescription(aKey);
     }

void edm::eventsetup::EventSetupRecord::setImpl	(	EventSetupRecordImpl const *	iImpl,
		unsigned int	transitionID,
		ESProxyIndex const *	getTokenIndices
	)

inline

Definition at line 107 of file EventSetupRecord.h.

                                                                                                                       {
         impl_ = iImpl;
         transitionID_ = transitionID;
         getTokenIndices_ = getTokenIndices;
       }

unsigned int edm::eventsetup::EventSetupRecord::transitionID ( ) const

inlineprotected

Definition at line 229 of file EventSetupRecord.h.

References class-composition::H, and dttmaxenums::R.

Referenced by edm::eventsetup::DependentRecordImplementation< EcalLaserDbRecord, boost::mpl::vector< EcalLaserAlphasRcd, EcalLaserAPDPNRatiosRefRcd, EcalLaserAPDPNRatiosRcd, EcalLinearCorrectionsRcd > >::getRecord(), and edm::eventsetup::DependentRecordImplementation< EcalLaserDbRecord, boost::mpl::vector< EcalLaserAlphasRcd, EcalLaserAPDPNRatiosRefRcd, EcalLaserAPDPNRatiosRcd, EcalLinearCorrectionsRcd > >::tryToGetRecord().

229 { return transitionID_; }

edm::eventsetup::EventSetupRecord::transitionID_

unsigned int transitionID_

Definition: EventSetupRecord.h:257

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

protected

Definition at line 79 of file EventSetupRecord.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.";
         }
       }
     }