Very simple pass-through implementation of IProxyDict. More...

#include <SimpleView.h>

Inheritance diagram for SimpleView:

Collaboration diagram for SimpleView:

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

Public Member Functions
	DeclareInterfaceID (SimpleView, 2, 0)

	SimpleView ()=delete

	SimpleView (std::string const &Name, bool AllowFallThrough=true, std::string const &storeName="StoreGateSvc")

virtual	~SimpleView ()

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

virtual void	linkParent (const IProxyDict *parent)
	links to the previously used views through these parent views additional data objects become available More...

virtual 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 fallthrough. More...

virtual SG::DataProxy *	deep_proxy (const void *const pTransient) const
	get proxy for a given data object address in memory, but performs a deep search among all possible 'symlinked' containers TEMPORARY: This method is going away. More...

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

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

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

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

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

virtual StatusCode	addToStore (CLID id, SG::DataProxy *proxy)
	Add a new proxy to the store. More...

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

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 unsigned long	addRef ()

virtual unsigned long	release ()

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)

virtual const std::string &	name () const

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

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

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

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

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

void	setROI (const ElementLink< TrigRoiDescriptorCollection > &roi)

const ElementLink< TrigRoiDescriptorCollection > &	getROI () const

	DeclareInterfaceID (IProxyDict, 2, 0)

	DeclareInterfaceID (INamedInterface, 2, 0)

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...

Protected Attributes
ServiceHandle< StoreGateSvc >	m_store

ElementLink< TrigRoiDescriptorCollection >	m_roi

std::string	m_name

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

std::vector< std::string >	m_fallFilter

bool	m_allowFallThrough

Detailed Description

Very simple pass-through implementation of IProxyDict.

Most of the methods are copypasta and don't do anything

Author: Ben Wynne - ATLAS

Definition at line 34 of file SimpleView.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

◆ SimpleView() [1/2]

SimpleView::SimpleView ( )

delete

◆ SimpleView() [2/2]

SimpleView::SimpleView	(	std::string const &	Name,
		bool	AllowFallThrough = `true`,
		std::string const &	storeName = `"StoreGateSvc"`
	)

Definition at line 10 of file SimpleView.cxx.

                                                                                                  :
   m_store( storeName, Name ),
   m_roi(),
   m_name( Name ),
   m_allowFallThrough( AllowFallThrough )
 {
 }

◆ ~SimpleView()

SimpleView::~SimpleView ( )

virtual

Definition at line 18 of file SimpleView.cxx.

19 {

20 }

Member Function Documentation

◆ addRef()

unsigned long SimpleView::addRef ( )

virtual

Definition at line 204 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::addRef" );
   return 0;
 }

◆ addToStore()

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

virtual

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.

Implements IProxyDict.

Definition at line 146 of file SimpleView.cxx.

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

◆ boundHandle()

void SimpleView::boundHandle ( IResetable * handle )

virtual

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 from IProxyDict.

Definition at line 189 of file SimpleView.cxx.

 {
   return m_store->boundHandle( handle );
 }

◆ 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() [1/3]

IHiveStore::DeclareInterfaceID	(	INamedInterface	,
		2	,
		0
	)

inherited

◆ DeclareInterfaceID() [2/3]

IProxyDict::DeclareInterfaceID	(	IProxyDict	,
		2	,
		0
	)

inherited

◆ DeclareInterfaceID() [3/3]

SimpleView::DeclareInterfaceID	(	SimpleView	,
		2	,
		0
	)

◆ deep_proxy()

virtual SG::DataProxy* SimpleView::deep_proxy ( const void *const pTransient ) const

inlinevirtual

get proxy for a given data object address in memory, but performs a deep search among all possible 'symlinked' containers TEMPORARY: This method is going away.

Definition at line 72 of file SimpleView.h.

73 { return proxy (pTransient); }

◆ dump()

std::string SimpleView::dump ( const std::string & indent = "" ) const

Definition at line 252 of file SimpleView.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 * SimpleView::findProxy	(	const CLID &	id,
		const std::string &	key,
		const bool	allowFallThrough
	)		const

virtual

Reimplemented in DebugView.

Definition at line 75 of file SimpleView.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->impl()->findProxy( id, key, false );
     if ( isValid( inParentProxy ) ) {
       return inParentProxy;
     }
   }
   
   //Look in the default store if cound not find in any view - for instance for event-wise IDCs
   if ( (not isValid( localProxy )) and allowFallThrough ) {
  
     //Apply filtering
     if ( m_fallFilter.size() ) {
       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()

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

inlinevirtual

returns the links to the previously used views

Definition at line 58 of file SimpleView.h.

59 { return m_parents; }

◆ getROI()

const ElementLink< TrigRoiDescriptorCollection > & SimpleView::getROI ( ) const

Definition at line 248 of file SimpleView.cxx.

                                                                          {
   return m_roi;
 }

◆ hiveProxyDict()

IProxyDict * IProxyDict::hiveProxyDict ( )

overridevirtualinherited

Return the current event-slot-specific store.

The default version just returns this.

Implements IHiveStore.

Reimplemented in StoreGateSvc, and SGImplSvc.

Definition at line 83 of file IProxyDict.cxx.

 {
   return this;
 }

◆ keyToString() [1/2]

const std::string * SimpleView::keyToString ( IStringPool::sgkey_t key ) const

virtual

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 229 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::keyToString" );
   return m_store->keyToString( key );
 }

◆ keyToString() [2/2]

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

virtual

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 234 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::keyToString" );
   return m_store->keyToString( key, clid );
 }

◆ linkParent()

void SimpleView::linkParent ( const IProxyDict * parent )

virtual

links to the previously used views through these parent views additional data objects become available

Reimplemented in DebugView.

Definition at line 33 of file SimpleView.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()

const std::string & SimpleView::name ( ) const

virtual

Definition at line 219 of file SimpleView.cxx.

 {
   return m_name;
 }

◆ proxies()

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

virtual

Return the list of all current proxies in store.

Implements IProxyDict.

Definition at line 130 of file SimpleView.cxx.

 {
   return m_store->proxies();
 }

◆ proxy() [1/2]

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

virtual

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

Implements IProxyDict.

Reimplemented in DebugView.

Definition at line 70 of file SimpleView.cxx.

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

◆ proxy() [2/2]

SG::DataProxy * SimpleView::proxy ( const void *const pTransient ) const

virtual

Get a proxy referencing a given transient object.

Parameters

pTransient The object to find.

Returns 0 to flag failure

Implements IProxyDict.

Reimplemented in DebugView.

Definition at line 121 of file SimpleView.cxx.

 {
   return m_store->proxy( pTransient );
 }

◆ proxy_exact()

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

virtual

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.

Implements IProxyDict.

Definition at line 51 of file SimpleView.cxx.

 {
   return nullptr;
 }

◆ queryInterface()

StatusCode SimpleView::queryInterface	(	const InterfaceID &	ti,
		void **	pp
	)

virtual

Definition at line 214 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::queryInterface" );
   return StatusCode::FAILURE;
 }

◆ recordObject()

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

virtual

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.

Implements IProxyDict.

Reimplemented in DebugView.

Definition at line 179 of file SimpleView.cxx.

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

◆ registerKey()

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

virtual

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 239 of file SimpleView.cxx.

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

◆ release()

unsigned long SimpleView::release ( )

virtual

Definition at line 209 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::release" );
   return 0;
 }

◆ setFilter()

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

inline

Set a filtering rule for anything loaded via fallthrough.

Definition at line 64 of file SimpleView.h.

65 { m_fallFilter = inputFilter; }

◆ setROI()

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

Definition at line 244 of file SimpleView.cxx.

                                                                            {
   m_roi = roi;
 }

◆ 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()

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

virtual

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 225 of file SimpleView.cxx.

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

◆ tryELRemap()

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

virtual

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 from IProxyDict.

Definition at line 162 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::tryELRemap" );
   return m_store->tryELRemap( sgkey_in, index_in, sgkey_out, index_out );
 }

◆ unboundHandle()

void SimpleView::unboundHandle ( IResetable * handle )

virtual

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 from IProxyDict.

Definition at line 199 of file SimpleView.cxx.

 {
   return m_store->unboundHandle( handle );
 }

◆ viewKey()

std::string SimpleView::viewKey ( const std::string & key ) const

Construct a key as used in the parent store.

key The key as used in the view.

Definition at line 27 of file SimpleView.cxx.

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

Member Data Documentation

◆ m_allowFallThrough

bool SimpleView::m_allowFallThrough

protected

Definition at line 201 of file SimpleView.h.

◆ m_fallFilter

std::vector< std::string > SimpleView::m_fallFilter

protected

Definition at line 200 of file SimpleView.h.

◆ m_name

std::string SimpleView::m_name

protected

Definition at line 198 of file SimpleView.h.

◆ m_parents

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

protected

Definition at line 199 of file SimpleView.h.

◆ m_roi

ElementLink<TrigRoiDescriptorCollection> SimpleView::m_roi

protected

Definition at line 197 of file SimpleView.h.

◆ m_store

ServiceHandle< StoreGateSvc > SimpleView::m_store

protected

Definition at line 194 of file SimpleView.h.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ sgkey_t

Constructor & Destructor Documentation

◆ SimpleView() [1/2]

◆ SimpleView() [2/2]

◆ ~SimpleView()

Member Function Documentation

◆ addRef()

◆ addToStore()

◆ boundHandle()

◆ createObj()

◆ DeclareInterfaceID() [1/3]

◆ DeclareInterfaceID() [2/3]

◆ DeclareInterfaceID() [3/3]

◆ deep_proxy()

◆ dump()

◆ findProxy()

◆ getParentLinks()

◆ getROI()

◆ hiveProxyDict()

◆ keyToString() [1/2]

◆ keyToString() [2/2]

◆ linkParent()

◆ name()

◆ proxies()

◆ proxy() [1/2]

◆ proxy() [2/2]

◆ proxy_exact()

◆ queryInterface()

◆ recordObject()

◆ registerKey()

◆ release()

◆ setFilter()

◆ setROI()

◆ sourceID()

◆ stringToKey()

◆ tryELRemap()

◆ unboundHandle()

◆ viewKey()

Member Data Documentation

◆ m_allowFallThrough

◆ m_fallFilter

◆ m_name

◆ m_parents

◆ m_roi

◆ m_store