A "view" of the event store (IProxyDict). More...

#include <View.h>

Inheritance diagram for SG::View:

Collaboration diagram for SG::View:

Public Member Functions
	View (const std::string &name, int index, bool allowFallThrough=true, const std::string &storeName="StoreGateSvc")
	Create a new View instance. More...

	View ()=delete

virtual	~View ()=default

	View (const View &)=delete

View &	operator= (const View &)=delete

size_t	viewID () const
	Return view index. More...

void	linkParent (const IProxyDict *parent)
	Link to the previously used views. More...

const std::set< const SG::View * > &	getParentLinks () const
	Returns the links to the previously used views. More...

void	setFilter (std::vector< std::string > const &inputFilter)
	Set a filtering rule for anything loaded via fall-through. More...

void	setROI (const ElementLink< TrigRoiDescriptorCollection > &roi)
	Associated RoI with this view. More...

const ElementLink< TrigRoiDescriptorCollection > &	getROI () const
	Return associated RoI. More...

std::string	dump (const std::string &indent="") const
	Print content of the view. More...

IProxyDict interface
virtual const std::string &	name () const override
	Name of the view. More...

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

virtual SG::DataProxy *	proxy (const CLID &id, const std::string &key) const override
	Get proxy with given id and key. More...

virtual SG::DataProxy *	proxy (const void *const pTransient) const override
	Get a proxy referencing a given transient object. More...

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

virtual StatusCode	addToStore (CLID id, SG::DataProxy *proxy) override
	Add a new 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 void	boundHandle (IResetable *handle) override
	Tell the store that a handle has been bound to a proxy. More...

virtual void	unboundHandle (IResetable *handle) override
	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) override
	Test to see if the target of an ElementLink has moved. More...

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

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

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

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

Private Types
using	KeyMap_t = SG::ConcurrentSGKeyMap< sgkey_t >

Private Member Functions
SG::DataProxy *	findProxy (const CLID &id, const std::string &key, bool allowFallThrough) const
	Internal implementation of proxy() More...

std::string	viewKey (const std::string &key) const
	Construct a key as used in the parent store. More...

Private Attributes
ServiceHandle< StoreGateSvc >	m_store

ElementLink< TrigRoiDescriptorCollection >	m_roi

KeyMap_t	m_keyMap

std::set< const SG::View * >	m_parents

std::vector< std::string >	m_fallFilter

std::string	m_name

size_t	m_index {0}

bool	m_allowFallThrough {true}

Detailed Description

A "view" of the event store (IProxyDict).

This class provides a view of the event store by mangling (prefixing) the key name with a fixed string (see viewKey()). Usually the view is carried by the (extended) EventContext and automatically applied for algorithms running within a view. For creating/accessing objects from outside the view, the view needs to be explicitly set via VarHandleBase::setProxyDict() on the handle (see AthViews/ViewHelper.h).

The lookup of an object proceeds in the following order:

the current view
the parent view if linked
the full store if allowFallThrough is set

Definition at line 46 of file View.h.

Member Typedef Documentation

◆ KeyMap_t

using SG::View::KeyMap_t = SG::ConcurrentSGKeyMap<sgkey_t>

private

Definition at line 274 of file View.h.

Constructor & Destructor Documentation

◆ View() [1/3]

SG::View::View	(	const std::string &	name,
		int	index,
		bool	allowFallThrough = `true`,
		const std::string &	storeName = `"StoreGateSvc"`
	)

Create a new View instance.

Parameters

name	Name of the view
index	Index of the view (gets appended to the name if index >= 0)
allowFallThrough	Allow fall-back to default store if object not found within the view
storeName	Store name

Definition at line 18 of file View.cxx.

                                                                                                   :
   m_store( storeName, name ),
   m_keyMap(KeyMap_t::Updater_t()),
   m_name( name ),
   m_allowFallThrough( allowFallThrough )
 {
   if ( index >= 0 ) {
     m_index = index;
     m_name += '_';
     m_name += std::to_string( index );
   }
 }

◆ View() [2/3]

SG::View::View ( )

delete

◆ ~View()

virtual SG::View::~View ( )

virtualdefault

◆ View() [3/3]

SG::View::View ( const View & )

delete

Member Function Documentation

◆ addToStore()

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

inlineoverridevirtual

Add a new proxy to the store.

Parameters

id	CLID as which the proxy should be added.
proxy	The proxy to add.

Simple addition of a proxy to the store. The key is taken as the primary key of the proxy. Does not handle things like overwrite, history, symlinks, etc. Should return failure if there is already an entry for this clid/key.

Definition at line 172 of file View.h.

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

◆ boundHandle()

virtual void SG::View::boundHandle ( IResetable * handle )

inlineoverridevirtual

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

Parameters

handle The handle that was bound.

Definition at line 196 of file View.h.

                                                            {
       return m_store->boundHandle( handle );
     }

◆ dump()

std::string SG::View::dump ( const std::string & indent = "" ) const

Print content of the view.

Definition at line 164 of file View.cxx.

 {
   // Dump view contents
   std::string ret = indent + "Dump " + name() + "\n";
   ret += indent + "[";
   for ( const SG::DataProxy* dp: proxies() ) {
     if ( dp->name().find( name() ) == 0 ) 
       ret += " " + dp->name();
   }
   ret += " ]\n";
  
   // Dump parent views
   if ( m_parents.size() ) ret += indent + "Parents:\n";
   for ( auto p : m_parents ) {
     ret += p->dump( indent + "  " );
   }
  
   // Fallthrough
   if ( indent == "" ) {
     if ( m_allowFallThrough ) {
       ret += indent + "May access main store: " + m_store->name();
     } else {
       ret += indent + "May not access main store";
     }
   }
   return ret;
 }

◆ findProxy()

SG::DataProxy * SG::View::findProxy	(	const CLID &	id,
		const std::string &	key,
		bool	allowFallThrough
	)		const

private

Internal implementation of proxy()

Definition at line 121 of file View.cxx.

 {
   auto isValid = [](const SG::DataProxy* p) { return p != nullptr and p->isValid(); };
   auto localProxy = m_store->proxy( id, viewKey(key) );
   if ( isValid( localProxy ) ) {
     return localProxy;
   }
  
   for ( auto parent: m_parents ) {
     // Don't allow parents to access whole-event store independently of this view
     auto inParentProxy = parent->findProxy( id, key, false );
     if ( isValid( inParentProxy ) ) {
       return inParentProxy;
     }
   }
   
   //Look in the default store if could not find in any view - for instance for event-wise IDCs
   if ( (not isValid( localProxy )) and allowFallThrough ) {
  
     //Apply filtering
     if ( !m_fallFilter.empty() ) {
       bool filterPass = false;
  
       //Filter passes if the key contains one of the possible values
       for ( auto& entry : m_fallFilter ) {
         if ( key.find( entry ) != std::string::npos ) {
           filterPass = true;
           break;
         }
       }
  
       if ( !filterPass ) return nullptr;
     }
  
     return m_store->proxy( id, key );
   }
   return nullptr;
 }

◆ getParentLinks()

const std::set< const SG::View* >& SG::View::getParentLinks ( ) const

inline

Returns the links to the previously used views.

Definition at line 78 of file View.h.

                                                           {
       return m_parents;
     }

◆ getROI()

const ElementLink<TrigRoiDescriptorCollection>& SG::View::getROI ( ) const

inline

Return associated RoI.

Definition at line 100 of file View.h.

                                                                    {
       return m_roi;
     }

◆ keyToString() [1/2]

const std::string * SG::View::keyToString ( IStringPool::sgkey_t key ) const

overridevirtual

Find the string and CLID corresponding to a given key.

Not supported. Will throw std::runtime_error.

Definition at line 203 of file View.cxx.

 {
   throw std::runtime_error( "Not implemented: SG::View::keyToString" );
 }

◆ keyToString() [2/2]

const std::string * SG::View::keyToString	(	IStringPool::sgkey_t	key,
		CLID &	clid
	)		const

overridevirtual

Find the string corresponding to a given key.

Not supported. Will throw std::runtime_error.

Definition at line 198 of file View.cxx.

 {
   throw std::runtime_error( "Not implemented: SG::View::keyToString" );
 }

◆ linkParent()

void SG::View::linkParent ( const IProxyDict * parent )

Link to the previously used views.

Definition at line 35 of file View.cxx.

                                                   {
   auto castParent = dynamic_cast< const SG::View* >( parent );
   if ( castParent ) {
     m_parents.insert( castParent );
   }
   else {
     throw std::runtime_error( "Unable to link parent view that cannot be cast to SG::View" );
   }
 }

◆ name()

virtual const std::string& SG::View::name ( ) const

inlineoverridevirtual

Name of the view.

Definition at line 117 of file View.h.

                                                    {
       return m_name;
     }

◆ operator=()

View& SG::View::operator= ( const View & )

delete

◆ proxies()

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

inlineoverridevirtual

Return the list of all current proxies in store.

Definition at line 158 of file View.h.

                                                                    {
       return m_store->proxies();
     }

◆ proxy() [1/2]

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

overridevirtual

Get proxy with given id and key.

Parameters

id	The `CLID` of the desired object.
key	The key of the desired object.

If the key is a null string, then it is a default key. Finding a proxy via the default key should succeed only if there is exactly one object with the given CLID in the store. Finding a proxy via a default key is considered deprecated for the case of the event store.

Returns 0 to flag failure

Definition at line 112 of file View.cxx.

 {
   return findProxy( id, key, m_allowFallThrough );
 }

◆ proxy() [2/2]

virtual SG::DataProxy* SG::View::proxy ( const void *const pTransient ) const

inlineoverridevirtual

Get a proxy referencing a given transient object.

Parameters

pTransient The object to find.

Returns 0 to flag failure

Definition at line 151 of file View.h.

                                                                             {
       return m_store->proxy( pTransient );
     }

◆ proxy_exact()

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

overridevirtual

Get proxy given a hashed key+clid.

Parameters

sgkey Hashed key to look up.

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

Parameters

sgkey Hashed key to look up.

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

Note: The implementation of proxy_exact is a bit special for the view case. This method is called by the Read/WriteHandle to avoid lengthy lookups via the string key. However, the sgkey that is passed is the hashed key of the original HandleKey (without the view prefix). So whenever we store an object in a view, we calculate the raw hashed key in recordObject() and store a mapping to the hashed view key to be able to retrieve the correct proxy here.

Definition at line 90 of file View.cxx.

                                                          {
   auto itr = m_keyMap.find(sgkey);
   if (itr != m_keyMap.end()) {
     return m_store->proxy_exact( itr->second );
   }
   else return nullptr;
 }

◆ recordObject()

SG::DataProxy * SG::View::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.

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

Returns the proxy for the recorded object; nullptr on failure.

Definition at line 57 of file View.cxx.

 {
   // Record the object under the view name
   SG::DataProxy* proxy = m_store->recordObject( obj, viewKey(key), allowMods, returnExisting );
  
   // Remember the hashed rawKey -> viewKey mapping for use in proxy_exact
   if (proxy) {
     const IStringPool::sgkey_t keyNoView = m_store->stringToKey( key, obj->clID() );
     m_keyMap.emplace(keyNoView, proxy->sgkey());
   }
  
   return proxy;
 }

◆ registerKey()

virtual void SG::View::registerKey	(	IStringPool::sgkey_t	key,
		const std::string &	str,
		CLID	clid
	)

inlineoverridevirtual

Remember an additional mapping from key to string/CLID.

Definition at line 251 of file View.h.

                                                                                                  {
       m_store->registerKey( key, viewKey(str), clid );
     }

◆ setFilter()

void SG::View::setFilter ( std::vector< std::string > const & inputFilter )

inline

Set a filtering rule for anything loaded via fall-through.

Parameters

inputFilter Only allow keys containing one these strings to fall-through.

Definition at line 86 of file View.h.

                                                                 {
       m_fallFilter = inputFilter;
     }

◆ setROI()

void SG::View::setROI ( const ElementLink< TrigRoiDescriptorCollection > & roi )

inline

Associated RoI with this view.

Definition at line 93 of file View.h.

                                                                      {
       m_roi = roi;
     }

◆ stringToKey()

virtual IStringPool::sgkey_t SG::View::stringToKey	(	const std::string &	str,
		CLID	clid
	)

inlineoverridevirtual

Find the key for a string/CLID pair.

Definition at line 244 of file View.h.

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

◆ tryELRemap()

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

overridevirtual

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.

Not supported. Will throw std::runtime_error.

Definition at line 193 of file View.cxx.

 {
   throw std::runtime_error( "Not implemented: SG::View::tryELRemap" );
 }

◆ unboundHandle()

virtual void SG::View::unboundHandle ( IResetable * handle )

inlineoverridevirtual

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

Parameters

handle The handle that was unbound.

Definition at line 204 of file View.h.

                                                              {
       return m_store->unboundHandle( handle );
     }

◆ viewID()

size_t SG::View::viewID ( ) const

inline

Return view index.

Definition at line 66 of file View.h.

                           {
       return m_index;
     }

◆ viewKey()

std::string SG::View::viewKey ( const std::string & key ) const

inlineprivate

Construct a key as used in the parent store.

Parameters

key	The key as used in the view.

Definition at line 267 of file View.h.

                                                    {
       return SG::transientKey (m_name + "_" + key);
     }

Member Data Documentation

◆ m_allowFallThrough

bool SG::View::m_allowFallThrough {true}

private

Definition at line 282 of file View.h.

◆ m_fallFilter

std::vector< std::string > SG::View::m_fallFilter

private

Definition at line 278 of file View.h.

◆ m_index

size_t SG::View::m_index {0}

private

Definition at line 281 of file View.h.

◆ m_keyMap

KeyMap_t SG::View::m_keyMap

private

Definition at line 275 of file View.h.

◆ m_name

std::string SG::View::m_name

private

Definition at line 280 of file View.h.

◆ m_parents

std::set< const SG::View* > SG::View::m_parents

private

Definition at line 277 of file View.h.

◆ m_roi

ElementLink<TrigRoiDescriptorCollection> SG::View::m_roi

private

Definition at line 272 of file View.h.

◆ m_store

ServiceHandle< StoreGateSvc > SG::View::m_store

private

Definition at line 271 of file View.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ KeyMap_t

Constructor & Destructor Documentation

◆ View() [1/3]

◆ View() [2/3]

◆ ~View()

◆ View() [3/3]

Member Function Documentation

◆ addToStore()

◆ boundHandle()

◆ dump()

◆ findProxy()

◆ getParentLinks()

◆ getROI()

◆ keyToString() [1/2]

◆ keyToString() [2/2]

◆ linkParent()

◆ name()

◆ operator=()

◆ proxies()

◆ proxy() [1/2]

◆ proxy() [2/2]

◆ proxy_exact()

◆ recordObject()

◆ registerKey()

◆ setFilter()

◆ setROI()

◆ stringToKey()

◆ tryELRemap()

◆ unboundHandle()

◆ viewID()

◆ viewKey()

Member Data Documentation

◆ m_allowFallThrough

◆ m_fallFilter

◆ m_index

◆ m_keyMap

◆ m_name

◆ m_parents

◆ m_roi

◆ m_store