A service that caches a pointer to the currently active store. It also implements the IProxyDict store interface. More...

#include <ActiveStoreSvc.h>

Inheritance diagram for ActiveStoreSvc:

Collaboration diagram for ActiveStoreSvc:

Public Types
typedef SG::sgkey_t	sgkey_t
	Type of the keys. More...

Public Member Functions
StoreGateSvc *	activeStore () const
	returns pointer to the active store as StoreGateSvc More...

StoreGateSvc *	operator-> () const
	dereference operator to access the active store More...

void	setStore (StoreGateSvc *s)
	set the active store pointer: used by the event loop mgrs More...

virtual SG::DataProxy *	proxy (const void *const pTransient) const override
	get proxy for a given data object address in memory More...

virtual SG::DataProxy *	proxy (const CLID &id, const std::string &key) const override
	get proxy with given id and key. Returns 0 to flag failure More...

virtual SG::DataProxy *	proxy_exact (SG::sgkey_t sgkey) const override
	Get proxy given a hashed key+clid. More...

virtual std::vector< const SG::DataProxy * >	proxies () const override
	return the list of all current proxies in store More...

StatusCode	addToStore (CLID id, SG::DataProxy *proxy) override
	Raw addition of a proxy to the store. More...

virtual SG::DataProxy *	recordObject (SG::DataObjectSharedPtr< DataObject > obj, const std::string &key, bool allowMods, bool returnExisting) override
	Record an object in the store. More...

virtual sgkey_t	stringToKey (const std::string &str, CLID clid) override
	Find the key for a string/CLID pair. More...

virtual const std::string *	keyToString (sgkey_t key) const override
	Find the string corresponding to a given key. More...

virtual const std::string *	keyToString (sgkey_t key, CLID &clid) const override
	Find the string and CLID corresponding to a given key. More...

virtual void	registerKey (sgkey_t key, const std::string &str, CLID clid) override
	Remember an additional mapping from key to string/CLID. More...

virtual StatusCode	initialize () override
	Service initialization. More...

virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface) override

	ActiveStoreSvc (const std::string &name, ISvcLocator *svc)
	Standard Service Constructor. sets active store to default event store. More...

virtual	~ActiveStoreSvc () override
	Standard Destructor. More...

virtual SG::DataProxy *	proxy (const CLID &id, const std::string &key) const=0
	TEMPORARY: avoid warnings. More...

virtual SG::DataProxy *	proxy (const void *const pTransient) const=0
	TEMPORARY: avoid warnings. More...

	DeclareInterfaceID (IProxyDict, 2, 0)

virtual void	boundHandle (IResetable *handle)
	Tell the store that a handle has been bound to a proxy. More...

virtual void	unboundHandle (IResetable *handle)
	Tell the store that a handle has been unbound from a proxy. More...

virtual bool	tryELRemap (sgkey_t sgkey_in, size_t index_in, sgkey_t &sgkey_out, size_t &index_out)
	Test to see if the target of an ElementLink has moved. More...

virtual StatusCode	createObj (IConverter cvt, IOpaqueAddress addr, DataObject *&refpObject)
	Call converter to create an object, possibly with locking. More...

virtual IProxyDict *	hiveProxyDict () override
	Return the current event-slot-specific store. More...

virtual SG::SourceID	sourceID (const std::string &key="EventSelector") const
	Return the metadata source ID for the current event slot. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	not really kosher: should be in IActiveStoreSvc More...

Private Member Functions
StoreGateSvc *	activeStoreOOL () const

Private Attributes
std::string	m_storeName

Detailed Description

A service that caches a pointer to the currently active store. It also implements the IProxyDict store interface.

In most jobs the active store is simply the default event store (named "StoreGateSvc"). When doing pile-up (and perhaps later on in multi-threaded jobs, the active store changes during the event loop execution. It is important, for example, that converters always refer to the active store rather than to the default one.

Author: ATLAS Collaboration

Definition at line 29 of file ActiveStoreSvc.h.

Member Typedef Documentation

◆ sgkey_t

typedef SG::sgkey_t IStringPool::sgkey_t

inherited

Type of the keys.

Definition at line 34 of file IStringPool.h.

Constructor & Destructor Documentation

◆ ActiveStoreSvc()

ActiveStoreSvc::ActiveStoreSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Service Constructor. sets active store to default event store.

Standard Constructor.

Definition at line 16 of file ActiveStoreSvc.cxx.

                                                                      : 
   Service(name,svc),
   m_storeName()
 {
   declareProperty("StoreName", m_storeName=StoreID::storeName(StoreID::EVENT_STORE));
 }

◆ ~ActiveStoreSvc()

ActiveStoreSvc::~ActiveStoreSvc ( )

overridevirtual

Standard Destructor.

Definition at line 25 of file ActiveStoreSvc.cxx.

26 {}

Member Function Documentation

◆ activeStore()

StoreGateSvc* ActiveStoreSvc::activeStore ( ) const

inline

returns pointer to the active store as StoreGateSvc

Definition at line 35 of file ActiveStoreSvc.h.

                                            {
     // Can't just `return StoreGateSvc::currentStoreGate()` due to
     // a circular dependency
     return activeStoreOOL();
   }

◆ activeStoreOOL()

StoreGateSvc * ActiveStoreSvc::activeStoreOOL ( ) const

private

Definition at line 188 of file ActiveStoreSvc.cxx.

 {
   return StoreGateSvc::currentStoreGate();
 }

◆ addToStore()

StatusCode ActiveStoreSvc::addToStore	(	CLID	id,
		SG::DataProxy *	proxy
	)

overridevirtual

Raw addition of a proxy to the store.

Implements IProxyDict.

Definition at line 73 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->addToStore (id, proxy);
 }

◆ boundHandle()

void IProxyDict::boundHandle ( IResetable * handle )

virtualinherited

Tell the store that a handle has been bound to a proxy.

Parameters

handle The handle that was bound. The default implementation does nothing.

Reimplemented in SGImplSvc.

Definition at line 23 of file IProxyDict.cxx.

24 {

25 }

◆ createObj()

StatusCode IProxyDict::createObj	(	IConverter *	cvt,
		IOpaqueAddress *	addr,
		DataObject *&	refpObject
	)

virtualinherited

Call converter to create an object, possibly with locking.

Parameters

cvt	The converter to call.
addr	Opaque address information for the object to create.
refpObject	Reference to location of the pointer of the created object.

This calls the createObj method on cvt to create the referenced transient object.

This will also lock the store, if that is required.

The default implementation just forwards the method call, with no locking.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 70 of file IProxyDict.cxx.

 {
   return cvt->createObj (addr, refpObject);
 }

◆ DeclareInterfaceID()

IProxyDict::DeclareInterfaceID	(	IProxyDict	,
		2	,
		0
	)

inherited

◆ hiveProxyDict()

IProxyDict * IProxyDict::hiveProxyDict ( )

overridevirtualinherited

Return the current event-slot-specific store.

The default version just returns this.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 83 of file IProxyDict.cxx.

 {
   return this;
 }

◆ initialize()

StatusCode ActiveStoreSvc::initialize ( )

overridevirtual

Service initialization.

Definition at line 30 of file ActiveStoreSvc.cxx.

                                          {
  
   CHECK( Service::initialize() );
  
   msg() << MSG::VERBOSE << "Initializing " << name() << endmsg;
  
   SmartIF<StoreGateSvc> storeGate{service(m_storeName, /*createIf*/true)};
   CHECK( storeGate.isValid() );
   storeGate->makeCurrent();
  
   return StatusCode::SUCCESS;
 }

◆ interfaceID()

const InterfaceID & ActiveStoreSvc::interfaceID ( )

static

not really kosher: should be in IActiveStoreSvc

Definition at line 167 of file ActiveStoreSvc.cxx.

                                                { 
   static const InterfaceID IDActiveStoreSvc("ActiveStoreSvc", 1, 0);
   return IDActiveStoreSvc; 
 }

◆ keyToString() [1/2]

const std::string * ActiveStoreSvc::keyToString ( sgkey_t key ) const

overridevirtual

Find the string corresponding to a given key.

Parameters

key	The key to look up.

Returns: Pointer to the string found, or null. We can find keys as long as the corresponding string was given to either stringToKey() or registerKey().

Implements IStringPool.

Definition at line 126 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->keyToString (key);
 }

◆ keyToString() [2/2]

const std::string * ActiveStoreSvc::keyToString	(	sgkey_t	key,
		CLID &	clid
	)		const

overridevirtual

Find the string and CLID corresponding to a given key.

Parameters

key	The key to look up.
clid[out]	The found CLID.

Returns: Pointer to the string found, or null. We can find keys as long as the corresponding string was given to either stringToKey() or registerKey().

Implements IStringPool.

Definition at line 140 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->keyToString (key, clid);
 }

◆ operator->()

StoreGateSvc* ActiveStoreSvc::operator-> ( ) const

inline

dereference operator to access the active store

Definition at line 42 of file ActiveStoreSvc.h.

                                           {
     return activeStore();
   }

◆ proxies()

std::vector< const SG::DataProxy * > ActiveStoreSvc::proxies ( ) const

overridevirtual

return the list of all current proxies in store

Implements IProxyDict.

Definition at line 67 of file ActiveStoreSvc.cxx.

                               {
   return activeStore()->proxies();
 }

◆ proxy() [1/4]

DataProxy * ActiveStoreSvc::proxy	(	const CLID &	id,
		const std::string &	key
	)		const

overridevirtual

get proxy with given id and key. Returns 0 to flag failure

Implements IProxyDict.

Definition at line 56 of file ActiveStoreSvc.cxx.

                                                                 { 
   return activeStore()->proxy(id,key);
 }

◆ proxy() [2/4]

virtual SG::DataProxy* IProxyDict::proxy

TEMPORARY: avoid warnings.

◆ proxy() [3/4]

DataProxy * ActiveStoreSvc::proxy ( const void *const pTransient ) const

overridevirtual

get proxy for a given data object address in memory

Implements IProxyDict.

Definition at line 50 of file ActiveStoreSvc.cxx.

                                                         {
   return activeStore()->proxy(pTransient);
 }

◆ proxy() [4/4]

virtual SG::DataProxy* IProxyDict::proxy

TEMPORARY: avoid warnings.

◆ proxy_exact()

SG::DataProxy * ActiveStoreSvc::proxy_exact ( SG::sgkey_t sgkey ) const

overridevirtual

Get proxy given a hashed key+clid.

Find an exact match; no handling of aliases, etc. Returns 0 to flag failure.

Implements IProxyDict.

Definition at line 60 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->proxy_exact (sgkey);
 }

◆ queryInterface()

StatusCode ActiveStoreSvc::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)

overridevirtual

Definition at line 171 of file ActiveStoreSvc.cxx.

 {
   if ( interfaceID().versionMatch(riid) )    {
     *ppvInterface = (ActiveStoreSvc*)this;
   }
   else if ( IProxyDict::interfaceID().versionMatch(riid) )    {
     *ppvInterface = (IProxyDict*)this;
   }
   else  {
     // Interface is not directly available: try out a base class
     return Service::queryInterface(riid, ppvInterface);
   }
   addRef();
   return StatusCode::SUCCESS;
 }

◆ recordObject()

SG::DataProxy * ActiveStoreSvc::recordObject	(	SG::DataObjectSharedPtr< DataObject >	obj,
		const std::string &	key,
		bool	allowMods,
		bool	returnExisting
	)

overridevirtual

Record an object in the store.

Parameters

obj	The data object to store.
key	The key as which it should be stored.
allowMods	If false, the object will be recorded as const.
returnExisting	If true, return proxy if this key already exists.

Full-blown record. obj should usually be something deriving from SG::DataBucket.

Returns the proxy for the recorded object; nullptr on failure. If the requested CLID/key combination already exists in the store, the behavior is controlled by returnExisting. If true, then the existing proxy is returned; otherwise, nullptr is returned. In either case, obj is destroyed.

Implements IProxyDict.

Definition at line 96 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->recordObject (obj, key, allowMods, returnExisting);
 }

◆ registerKey()

void ActiveStoreSvc::registerKey	(	sgkey_t	key,
		const std::string &	str,
		CLID	clid
	)

overridevirtual

Remember an additional mapping from key to string/CLID.

Parameters

key	The key to enter.
str	The string to enter.
clid	The CLID associated with the string.

Returns: True if successful; false if the key already corresponds to a different string.

This registers an additional mapping from a key to a string; it can be found later through lookup() on the string. Logs an error if key already corresponds to a different string.

Implements IStringPool.

Definition at line 159 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->registerKey (key, str, clid);
 }

◆ setStore()

void ActiveStoreSvc::setStore ( StoreGateSvc * s )

set the active store pointer: used by the event loop mgrs

Definition at line 44 of file ActiveStoreSvc.cxx.

                                              {
   s->makeCurrent();
 }

◆ sourceID()

SG::SourceID IProxyDict::sourceID ( const std::string & key = "EventSelector" ) const

virtualinherited

Return the metadata source ID for the current event slot.

Parameters

key	SG key of the DataHeader to query. Returns an empty string if no source has been set.

The default version always returns an empty string.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 97 of file IProxyDict.cxx.

 {
   return SG::SourceID();
 }

◆ stringToKey()

sgkey_t ActiveStoreSvc::stringToKey	(	const std::string &	str,
		CLID	clid
	)

overridevirtual

Find the key for a string/CLID pair.

Parameters

str	The string to look up.
clid	The CLID associated with the string.

Returns: A key identifying the string. A given string will always return the same key. Will abort in case of a hash collision!

Implements IStringPool.

Definition at line 113 of file ActiveStoreSvc.cxx.

 {
   return activeStore()->stringToKey (str, clid);
 }

◆ tryELRemap()

bool IProxyDict::tryELRemap	(	sgkey_t	sgkey_in,
		size_t	index_in,
		sgkey_t &	sgkey_out,
		size_t &	index_out
	)

virtualinherited

Test to see if the target of an ElementLink has moved.

Parameters

sgkey_in	Original hashed key of the EL.
index_in	Original index of the EL.
sgkey_out[out]	New hashed key for the EL.
index_out[out]	New index for the EL.

Returns: True if there is a remapping; false otherwise.

The default implementation here always returns false.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 48 of file IProxyDict.cxx.

 {
   return false;
 }

◆ unboundHandle()

void IProxyDict::unboundHandle ( IResetable * handle )

virtualinherited

Tell the store that a handle has been unbound from a proxy.

Parameters

handle The handle that was unbound. The default implementation does nothing.

Reimplemented in SGImplSvc.

Definition at line 33 of file IProxyDict.cxx.

34 {

35 }

Member Data Documentation

◆ m_storeName

std::string ActiveStoreSvc::m_storeName

private

Definition at line 159 of file ActiveStoreSvc.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ sgkey_t

Constructor & Destructor Documentation

◆ ActiveStoreSvc()

◆ ~ActiveStoreSvc()

Member Function Documentation

◆ activeStore()

◆ activeStoreOOL()

◆ addToStore()

◆ boundHandle()

◆ createObj()

◆ DeclareInterfaceID()

◆ hiveProxyDict()

◆ initialize()

◆ interfaceID()

◆ keyToString() [1/2]

◆ keyToString() [2/2]

◆ operator->()

◆ proxies()

◆ proxy() [1/4]

◆ proxy() [2/4]

◆ proxy() [3/4]

◆ proxy() [4/4]

◆ proxy_exact()

◆ queryInterface()

◆ recordObject()

◆ registerKey()

◆ setStore()

◆ sourceID()

◆ stringToKey()

◆ tryELRemap()

◆ unboundHandle()

Member Data Documentation

◆ m_storeName