edm::eventsetup::DataProxy Class Reference

#include <DataProxy.h>

Inheritance diagram for edm::eventsetup::DataProxy:

Public Member Functions
bool	cacheIsValid () const
	DataProxy ()
void	doGet (EventSetupRecord const &iRecord, DataKey const &iKey, bool iTransiently) const
void const *	get (EventSetupRecord const &, DataKey const &iKey, bool iTransiently) const
void	invalidate ()
ComponentDescription const *	providerDescription () const
	returns the description of the DataProxyProvider which owns this Proxy More...
void	resetIfTransient ()
void	setProviderDescription (ComponentDescription const *iDesc)
virtual	~DataProxy ()

Protected Member Functions
void	clearCacheIsValid ()
virtual void const *	getImpl (EventSetupRecord const &, DataKey const &iKey)=0
virtual void	invalidateCache ()=0
virtual void	invalidateTransientCache ()

Private Member Functions
	DataProxy (DataProxy const &)
DataProxy const &	operator= (DataProxy const &)

Private Attributes
void const *	cache_
std::atomic< bool >	cacheIsValid_
ComponentDescription const *	description_
std::atomic< bool >	nonTransientAccessRequested_

Detailed Description

Definition at line 34 of file DataProxy.h.

Constructor & Destructor Documentation

DataProxy< RecordT, DataT, Initializer >::DataProxy

(

)

Definition at line 42 of file DataProxy.cc.

                     :
   cache_(nullptr),
   cacheIsValid_(false),
   nonTransientAccessRequested_(false),
   description_(dummyDescription())
{
}

DataProxy< RecordT, DataT, Initializer >::~DataProxy ( )

virtual

Definition at line 55 of file DataProxy.cc.

{
}

edm::eventsetup::DataProxy::DataProxy ( DataProxy const &  )

private

Member Function Documentation

bool edm::eventsetup::DataProxy::cacheIsValid ( ) const

inline

Definition at line 41 of file DataProxy.h.

References cacheIsValid_.

Referenced by get(), and edm::eventsetup::EventSetupRecord::wasGotten().

{ return cacheIsValid_.load(std::memory_order_acquire); }

void DataProxy< RecordT, DataT, Initializer >::clearCacheIsValid ( )

protected

Definition at line 74 of file DataProxy.cc.

References cache_, cacheIsValid_, and nonTransientAccessRequested_.

Referenced by invalidate(), and resetIfTransient().

                                  {
   cacheIsValid_.store(false, std::memory_order_release);
   nonTransientAccessRequested_.store(false, std::memory_order_release);
   cache_ = 0;
}

void DataProxy< RecordT, DataT, Initializer >::doGet	(	EventSetupRecord const &	iRecord,
		DataKey const &	iKey,
		bool	iTransiently
	)		const

Definition at line 126 of file DataProxy.cc.

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

                                                                                                   {
   get(iRecord, iKey, iTransiently);
}

const void * DataProxy< RecordT, DataT, Initializer >::get	(	EventSetupRecord const &	iRecord,
		DataKey const &	iKey,
		bool	iTransiently
	)		const

Definition at line 104 of file DataProxy.cc.

References cache_, cacheIsValid(), cacheIsValid_, getImpl(), nonTransientAccessRequested_, and edm::eventsetup::s_esGlobalMutex.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), edm::eventsetup::EventSetupRecord::getFromProxy(), 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().

{
   if(!cacheIsValid()) {
      std::lock_guard<std::recursive_mutex> guard(s_esGlobalMutex);
      if(!cacheIsValid()) {
         cache_ = const_cast<DataProxy*>(this)->getImpl(iRecord, iKey);
         cacheIsValid_.store(true,std::memory_order_release);
      }
   }
   //We need to set the AccessType for each request so this can't be called in the if block above.
   //This also must be before the cache_ check since we want to setCacheIsValid before a possible
   // exception throw. If we don't, 'getImpl' will be called again on a second request for the data.
   if(!iTransiently) {
      nonTransientAccessRequested_.store(true, std::memory_order_release);
   }

   if(0 == cache_) {
      throwMakeException(iRecord, iKey);
   }
   return cache_;
}

virtual void const* edm::eventsetup::DataProxy::getImpl ( EventSetupRecord const &  , DataKey const &  iKey  )

protectedpure virtual

This is the function which does the real work of getting the data if it is not already cached. The returning 'void const*' must point to an instance of the class type corresponding to the type designated in iKey. So if iKey refers to a base class interface the pointer must be a pointer to that base class interface and not a pointer to an inheriting class instance.

Implemented in edm::eventsetup::CallbackProxy< CallbackT, RecordT, DataT >, and edm::eventsetup::DataProxyTemplate< RecordT, DataT >.

Referenced by get().

void edm::eventsetup::DataProxy::invalidate ( )

inline

Definition at line 53 of file DataProxy.h.

References clearCacheIsValid(), and invalidateCache().

                           {
            clearCacheIsValid();
            invalidateCache();
         }

virtual void edm::eventsetup::DataProxy::invalidateCache ( )

protectedpure virtual

indicates that the Proxy should invalidate any cached information as that information has 'expired' (i.e. we have moved to a new IOV)

Implemented in edm::eventsetup::CallbackProxy< CallbackT, RecordT, DataT >, and DataProxy< RecordT, DataT, Initializer >.

Referenced by invalidate(), and invalidateTransientCache().

void DataProxy< RecordT, DataT, Initializer >::invalidateTransientCache ( )

protectedvirtual

indicates that the Proxy should invalidate any cached information as that information was accessed transiently and therefore is not intended to be kept over the entire IOV. Default is to call invalidateCache().

Reimplemented in DataProxy< RecordT, DataT, Initializer >.

Definition at line 89 of file DataProxy.cc.

References invalidateCache().

Referenced by resetIfTransient().

                                    {
   invalidateCache();
}

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

private

ComponentDescription const* edm::eventsetup::DataProxy::providerDescription ( ) const

inline

returns the description of the DataProxyProvider which owns this Proxy

Definition at line 47 of file DataProxy.h.

References description_.

Referenced by edm::eventsetup::EventSetupRecord::add(), edm::eventsetup::EventSetupRecord::doGet(), edm::eventsetup::EventSetupRecord::getFromProxy(), and edm::eventsetup::EventSetupRecord::providerDescription().

                                                                 {
            return description_;
         }

void DataProxy< RecordT, DataT, Initializer >::resetIfTransient

(

)

Definition at line 81 of file DataProxy.cc.

References clearCacheIsValid(), invalidateTransientCache(), and nonTransientAccessRequested_.

                            {
   if (!nonTransientAccessRequested_.load(std::memory_order_acquire)) {
      clearCacheIsValid();
      invalidateTransientCache();
   }
}

void edm::eventsetup::DataProxy::setProviderDescription ( ComponentDescription const *  iDesc )

inline

Definition at line 60 of file DataProxy.h.

References description_.

                                                                        {
            description_ = iDesc;
         }

Member Data Documentation

void const* edm::eventsetup::DataProxy::cache_

mutableprivate

Definition at line 91 of file DataProxy.h.

Referenced by clearCacheIsValid(), and get().

std::atomic<bool> edm::eventsetup::DataProxy::cacheIsValid_

mutableprivate

Definition at line 92 of file DataProxy.h.

Referenced by cacheIsValid(), clearCacheIsValid(), and get().

ComponentDescription const* edm::eventsetup::DataProxy::description_

private

Definition at line 94 of file DataProxy.h.

Referenced by providerDescription(), and setProviderDescription().

std::atomic<bool> edm::eventsetup::DataProxy::nonTransientAccessRequested_

mutableprivate

Definition at line 93 of file DataProxy.h.

Referenced by clearCacheIsValid(), get(), and resetIfTransient().