Getter tool to retrieve DataVector/List collections from StoreGate. More...

#include <SGDataVectorGetterTool.h>

Inheritance diagram for D3PD::SGDataVectorGetterTool:

Collaboration diagram for D3PD::SGDataVectorGetterTool:

Public Member Functions
	SGDataVectorGetterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor. More...

virtual StatusCode	initialize ()
	Standard Gaudi `initialize` method. More...

virtual StatusCode	finalize ()
	Standard Gaudi `finalize` method. More...

virtual const std::type_info &	elementTypeinfo () const
	Return the element type of the collection. More...

virtual StatusCode	reset (bool allowMissing=false)
	Reset the iteration to the start of the collection. More...

virtual const void *	nextUntyped ()
	Return a pointer to the next element in the collection. More...

virtual size_t	sizeHint (bool allowMissing=false)
	Return an estimate of the number of elements in the iteration. More...

virtual const std::type_info &	typeinfo () const
	Return the type of object retrieved by this tool. More...

CLID	clid () const
	Return the class ID being read by this tool. More...

virtual const void *	getUntyped (bool allowMissing=false)
	Return the target object. More...

	DeclareInterfaceID (IObjGetterTool, 1, 0)
	Gaudi interface definition. More...

template<class T >
const T *	get (bool allowMissing=false)
	Type-safe wrapper for `get`. More...

virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the getter. More...

template<class T >
void	releaseObject (const T *p)
	Type-safe wrapper for `releaseObjectUntyped`. More...

template<class T >
StatusCode	configureD3PD ()
	Test type compatibility. More...

virtual const void *	getTypeinfo (const std::type_info &ti, bool allowMissing=false)=0
	Return the target object cast to a different pointer type. More...

void	releaseObjectTypeinfo (const void *p, const std::type_info &ti)
	Release an object retrieved from the getter. More...

virtual StatusCode	configureTypeinfo (const std::type_info &ti)=0
	Test type compatibility. More...

const void *	nextTypeinfo (const std::type_info &ti)
	Return the next object cast to a different pointer type. More...

StatusCode	configureElementTypeinfo (const std::type_info &ti)
	Test type compatibility. More...

void	releaseElementTypeinfo (const void *p, const std::type_info &ti)
	Release an element retrieved from the getter. More...

Protected Member Functions
StatusCode	initializeImpl ()
	Initialize this mixin class. More...

Protected Attributes
std::string	m_typename
	Property: Name of the type of the object being retrieved. More...

std::string	m_sgkey
	Property: StoreGate key of the object being retrieved. More...

ServiceHandle< IClassIDSvc >	m_clidsvc
	Property: Instance of the ClassIDSvc to use. More...

SGKeyResolver	m_resolver
	Helper: Resolve the SG key to use. More...

Private Member Functions
const DataModel_detail::DVLInfoBase *	getInfo (const std::type_info &ti)
	Retrieve DataVector/List information for this collection. More...

Private Attributes
ServiceHandle< IAthenaPoolCnvSvc >	m_athenaPoolCnvSvc
	Used to auto-load converters, if needed. More...

const DataModel_detail::DVLInfoBase *	m_info
	DataVector/List information for this collection. More...

DataModel_detail::DVLIteratorBase *	m_it
	Current iterator over the collection. More...

TypeConverter	m_converter
	Converter from the pointer that we get from StoreGate to a pointer to the collection over which we iterate (which may be a base of what we get from SG). More...

CLID	m_clid
	CLID for the object being retrieved. More...

ServiceHandle< StoreGateSvc > &	m_sg
	The event storage service. More...

std::string	m_label
	Property: label to assign to this getter (or null). More...

ToolHandle< ICollectionGetterRegistryTool >	m_registry
	The collection getter registry tool. More...

TypeConverter	m_backConverter
	Helper to convert pointers back, for `releaseElement`. More...

Detailed Description

Getter tool to retrieve DataVector/List collections from StoreGate.

This is a Getter tool that retrieves a collection of objects from StoreGate. This class handles DataVector and DataList collections. (Collections deriving from these may also be used, provided that proper SG_BASE macros were used.)

Properties: TypeName - Name of the type of the object being retrieved. SGKey - StoreGate key of the object being retrieved. Can also be a comma or space-separated list. In that case, the first key that actually exists in the data store will be used. ClassIDSvc - ClassIDSvc instance to use.

Definition at line 53 of file SGDataVectorGetterTool.h.

Constructor & Destructor Documentation

◆ SGDataVectorGetterTool()

D3PD::SGDataVectorGetterTool::SGDataVectorGetterTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

Definition at line 29 of file SGDataVectorGetterTool.cxx.

     : SGGetterImpl (name, this->evtStore()),
       CollectionGetterToolImpl (type, name, parent),
       m_athenaPoolCnvSvc ("AthenaPoolCnvSvc", name),
       m_info (0),
       m_it (0)
 {
   SGGETTERIMPL_PROPS;
 }

Member Function Documentation

◆ clid()

CLID D3PD::SGGetterImpl::clid ( ) const

inherited

Return the class ID being read by this tool.

Definition at line 54 of file SGGetterImpl.cxx.

 {
   return m_clid;
 }

◆ configureD3PD()

template<class T >

StatusCode D3PD::IObjGetterTool::configureD3PD ( )

inherited

Test type compatibility.

Test to see if the object being returned by the tool can be converted to a pointer to T. This can be used to perform type checks during job initialization.

This is implemented in terms of configureTypeinfo.

◆ configureElementTypeinfo()

StatusCode D3PD::CollectionGetterToolImpl::configureElementTypeinfo ( const std::type_info & ti )

inherited

Test type compatibility.

Parameters

ti	The desired type.

Test to see if the object being returned by the tool can be converted to a pointer to T. This can be used to perform type checks during job initialization.

Definition at line 146 of file CollectionGetterToolImpl.cxx.

 {
   return this->m_converter.init(this->elementTypeinfo(), ti);
 }

◆ configureTypeinfo()

virtual StatusCode D3PD::IObjGetterTool::configureTypeinfo ( const std::type_info & ti )

pure virtualinherited

Test type compatibility.

Parameters

ti	The desired type.

Test to see if the object being returned by the tool can be converted to a pointer to T. This can be used to perform type checks during job initialization.

◆ DeclareInterfaceID()

D3PD::IObjGetterTool::DeclareInterfaceID	(	IObjGetterTool	,
		1	,
		0
	)

inherited

Gaudi interface definition.

◆ elementTypeinfo()

const std::type_info & D3PD::SGDataVectorGetterTool::elementTypeinfo ( ) const

virtual

Return the element type of the collection.

I.e., nextUntyped returns a pointer to this type.

Definition at line 119 of file SGDataVectorGetterTool.cxx.

 {
   return m_info->elt_tinfo();
 }

◆ finalize()

StatusCode D3PD::SGDataVectorGetterTool::finalize ( )

virtual

Standard Gaudi finalize method.

Definition at line 106 of file SGDataVectorGetterTool.cxx.

 {
   delete m_it;
   m_it = 0;
   return StatusCode::SUCCESS;
 }

◆ get()

template<class T >

const T* D3PD::IObjGetterTool::get ( bool allowMissing = false )

inherited

Type-safe wrapper for get.

Parameters

allowMissing If true, then we should not generate errors if the requested object is missing.

Return the object as a pointer to T. Return 0 if the get fails or if the pointer can't be converted.

This is implemented in terms of getTypeinfo().

◆ getInfo()

const DataModel_detail::DVLInfoBase * D3PD::SGDataVectorGetterTool::getInfo ( const std::type_info & ti )

private

Retrieve DataVector/List information for this collection.

Parameters

ti	Type that we get from SG.

Definition at line 199 of file SGDataVectorGetterTool.cxx.

 {
   // If we have info for this class directly, use that.
   DataModel_detail::DVLInfoBase* info =
     DataModel_detail::DVLInfoBase::find (ti);
   if (info) return info;
  
   // We gotta check the base classes.  Fail if we don't have
   // base info.
   const SG::BaseInfoBase* bib = SG::BaseInfoBase::find (ti);
   if (!bib) return 0;
  
   // Pick the most-derived class among the possible bases.
   std::vector<const std::type_info*> bases = bib->get_ti_bases();
   for (size_t i = 0; i < bases.size(); i++) {
     DataModel_detail::DVLInfoBase* this_info =
       DataModel_detail::DVLInfoBase::find (*bases[i]);
     if (this_info) {
       if (info) {
         bib = SG::BaseInfoBase::find (this_info->tinfo());
         if (bib && bib->is_base (info->tinfo()))
           info = this_info;
       }
       else
         info = this_info;
     }
   }
   return info;
 }

◆ getTypeinfo()

virtual const void* D3PD::IObjGetterTool::getTypeinfo	(	const std::type_info &	ti,
		bool	allowMissing = `false`
	)

pure virtualinherited

Return the target object cast to a different pointer type.

Parameters

ti	The desired type.
allowMissing	If true, then we should not generate errors if the requested object is missing.

Return the object as a pointer to the ti type. Return 0 if the get fails or if the pointer can't be converted.

◆ getUntyped()

const void * D3PD::SGGetterImpl::getUntyped ( bool allowMissing = false )

virtualinherited

Return the target object.

Parameters

allowMissing If true, then we should not generate errors if the requested object is missing.

Should be of the type given by typeinfo. Return 0 on failure.

Implements D3PD::IObjGetterTool.

Definition at line 68 of file SGGetterImpl.cxx.

 {
   std::string key = m_resolver.key();
   SG::DataProxy* proxy = m_sg->proxy (m_clid, key);
   if (!proxy) {
     if (!allowMissing) {
       REPORT_MESSAGE (MSG::FATAL) << "Can't find object in event store for "
                                   << m_typename << "(" << m_clid << ")/" 
                                   << key;
       REPORT_MESSAGE (MSG::INFO) << m_sg->dump();
     }
     return 0;
   }
  
   void* ptr = SG::DataProxy_cast (proxy, m_clid);
   if (!ptr) {
     if (!allowMissing) {
       REPORT_MESSAGE (MSG::FATAL)
         << "Null object retrieved for " << m_typename << "(" << m_clid << ")/" 
         << key;
       REPORT_MESSAGE (MSG::INFO) << m_sg->dump();
     }
     return 0;
   }
  
   // Try to retrieve a corresponding aux store as well.
   m_sg->tryConstRetrieve<SG::IConstAuxStore> (key + "Aux.");
  
   return ptr;
 }

◆ initialize()

StatusCode D3PD::SGDataVectorGetterTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 46 of file SGDataVectorGetterTool.cxx.

 {
   CHECK( m_athenaPoolCnvSvc.retrieve() );
  
   // Initialize the code getting the collection from SG.
   CHECK( SGGetterImpl::initializeImpl() );
  
   // Find the DataVector/DataList information for this collection.
   m_info = getInfo (typeinfo());
  
   // We couldn't find it.
   // Maybe we haven't yet loaded a library that has a complete
   // instantiation of the DataVector class.  Try loading the pool
   // converter, and see if that'll do it.
   if (!m_info) {
     m_athenaPoolCnvSvc->converter (clid());
     m_info = getInfo (typeinfo());
   }
  
   // Maybe it didn't.  (Once we make the info method virtual, then loading
   // the converter should always do it.  But now, maybe not.)
   // As a last attempt, try to load a dictionary for the class.
   if (!m_info) {
     TClass* cls = gROOT->GetClass (m_typename.c_str());
     cls->GetBaseClass ("SG::AuxElement");
     m_info = getInfo (typeinfo());
   }
  
   // Ok, one more try...
   if (!m_info) {
     TClass* cls = gROOT->GetClass (m_typename.c_str());
     TMethodCall meth (cls, "initHelper", "");
     if (meth.IsValid())
       meth.Execute();
     m_info = getInfo (typeinfo());
   }
   if (!m_info) {
     TClass* cls = gROOT->GetClass (m_typename.c_str());
     TMethodCall meth (cls, "dvlinfo", "");
     if (meth.IsValid())
       meth.Execute();
     m_info = getInfo (typeinfo());
   }
  
   if (!m_info) {
     REPORT_MESSAGE (MSG::ERROR)
       << "Can't find DataVector/DataList info for class " << m_typename;
     return StatusCode::FAILURE;
   }
  
   // We need to convert from the type we get from SG to the DV/DL base class.
   CHECK( m_converter.init (typeinfo(), m_info->tinfo()) );
  
   return CollectionGetterToolImpl::initialize();
 }

◆ initializeImpl()

StatusCode D3PD::SGGetterImpl::initializeImpl ( )

protectedinherited

Initialize this mixin class.

Call this from initialize.

Definition at line 105 of file SGGetterImpl.cxx.

 {
   CHECK( m_clidsvc.retrieve() );
  
   CHECK( nameToCLID (m_typename, m_clid, this->name(), m_clidsvc) );
  
   CHECK( m_resolver.initialize (m_clid, m_typename) );
  
   return StatusCode::SUCCESS;
 }

◆ nextTypeinfo()

const void * D3PD::CollectionGetterToolImpl::nextTypeinfo ( const std::type_info & ti )

inherited

Return the next object cast to a different pointer type.

Return the next element from the collection as a pointer to the ti type. Return 0 if the pointer can't be converted or at the end of the iteration.

Definition at line 68 of file CollectionGetterToolImpl.cxx.

 {
   // Configure the converter.
   if (!this->m_converter.isValid() ||
       this->m_converter.dstTypeinfo() != ti)
   {
     if (this->configureElementTypeinfo(ti).isFailure())
       return 0;
   }
  
   // Get the next object.  If the conversion fails, loop until we get
   // a good one.
   while (true) {
     const void* p = this->nextUntyped();
     if (!p) return 0;
     const void* pconv = this->m_converter.convertUntyped (p);
     if (pconv) return pconv;
     this->releaseElementUntyped (p);
     REPORT_MESSAGE (MSG::WARNING)
       << "Pointer conversion from " << m_converter.srcName() << " to "
       << m_converter.dstName() << "failed.";
   }
 }

◆ nextUntyped()

const void * D3PD::SGDataVectorGetterTool::nextUntyped ( )

virtual

Return a pointer to the next element in the collection.

Return 0 when the collection has been exhausted.

Definition at line 167 of file SGDataVectorGetterTool.cxx.

 {
   if (m_it)
     return m_it->next();
   return 0;
 }

◆ releaseElementTypeinfo()

void D3PD::CollectionGetterToolImpl::releaseElementTypeinfo	(	const void *	p,
		const std::type_info &	ti
	)

inherited

Release an element retrieved from the getter.

Parameters

p	The element to release.
ti	The type of p.

Call this when you are done with the element returned by nextUntyped(). The default implementation is a no-op, but if the getter dynamically allocated the object which it returned, this gives it a chance to free it.

Definition at line 104 of file CollectionGetterToolImpl.cxx.

 {
   if (!p)
     return;
  
   // Configure the converter if needed.
   if (!this->m_backConverter.isValid() ||
       this->m_backConverter.srcTypeinfo() != ti)
   {
     if (this->m_backConverter.init (ti, this->typeinfo()).isFailure()) {
       REPORT_MESSAGE (MSG::WARNING)
         << "Can't configure pointer conversion from "
         << System::typeinfoName (ti) << " to "
         << System::typeinfoName (this->typeinfo());
       return;
     }
   }
  
   // Convert to the desired type.
   p = this->m_backConverter.convertUntyped (p);
  
   // Release.
   if (p)
     this->releaseElementUntyped (p);
   else {
     REPORT_MESSAGE (MSG::WARNING)
       << "Pointer conversion from " << m_backConverter.srcName() << " to "
       << m_backConverter.dstName() << "failed.";
   }
 }

◆ releaseObject()

template<class T >

void D3PD::IObjGetterTool::releaseObject ( const T * p )

inherited

Type-safe wrapper for releaseObjectUntyped.

Parameters

p	The object to release.

Call this when you are done with the object returned by get(). The default implementation is a no-op, but if the getter dynamically allocated the object which it returned, this gives it a chance to free it.

This is implemented in terms of releaseObjectTypeinfo().

◆ releaseObjectTypeinfo()

void D3PD::IObjGetterTool::releaseObjectTypeinfo	(	const void *	p,
		const std::type_info &	ti
	)

inherited

Release an object retrieved from the getter.

Parameters

p	The object to release.
ti	The type of p.

Call this when you are done with the object returned by getUntyped(). The default implementation is a no-op, but if the getter dynamically allocated the object which it returned, this gives it a chance to free it.

◆ releaseObjectUntyped()

virtual void D3PD::IObjGetterTool::releaseObjectUntyped ( const void * p )

virtualinherited

Release an object retrieved from the getter.

Parameters

p	The object to release.

Call this when you are done with the object returned by getUntyped(). The default implementation is a no-op, but if the getter dynamically allocated the object which it returned, this gives it a chance to free it.

◆ reset()

StatusCode D3PD::SGDataVectorGetterTool::reset ( bool allowMissing = false )

virtual

Reset the iteration to the start of the collection.

Parameters

allowMissing If true, then we should not generate errors if the requested object is missing.

Return failure if the container cannot be retrieved.

Definition at line 132 of file SGDataVectorGetterTool.cxx.

 {
   delete m_it;
   const void* p0 = getUntyped (allowMissing);
   if (allowMissing && p0 == 0) {
     m_it = 0;
     return StatusCode::SUCCESS;
   }
   const void* p = m_converter.convertUntyped (p0);
   if (p) {
     // need non-const pointer to call `base`
     void* nonconst_p ATLAS_THREAD_SAFE = const_cast<void*> (p);
     SG::AuxVectorBase* auxbase = m_info->base (nonconst_p);
     if (auxbase && auxbase->trackIndices() && !auxbase->getConstStore()) {
       // Try to retrieve a corresponding aux store.
       const SG::IConstAuxStore* store =
         evtStore()->tryConstRetrieve<SG::IConstAuxStore> (m_resolver.key() + "Aux.");
       if (store)
         auxbase->setStore (store);
     }
     m_it = m_info->iterator (p);
     return StatusCode::SUCCESS;
   }
   else {
     m_it = 0;
     return StatusCode::FAILURE;
   }
 }

◆ sizeHint()

size_t D3PD::SGDataVectorGetterTool::sizeHint ( bool allowMissing = false )

virtual

Return an estimate of the number of elements in the iteration.

Parameters

allowMissing If true, then we should not generate errors if the requested object is missing.

This can be used to pre-allocate memory. (It's possible that this isn't known in advance of iterating over the entire collection, for example if a selection is being applied, so this is only a hint.)

Definition at line 185 of file SGDataVectorGetterTool.cxx.

 {
   // need non-const pointer to call `size`
   void* p ATLAS_THREAD_SAFE = const_cast<void*>(m_converter.convertUntyped (getUntyped (allowMissing)));
   if (!p) return 0;
   return m_info->size (p);
 }

◆ typeinfo()

const std::type_info & D3PD::SGGetterImpl::typeinfo ( ) const

virtualinherited

Return the type of object retrieved by this tool.

Implements D3PD::IObjGetterTool.

Reimplemented in D3PD::SGCollectionGetterTool< CONT >, D3PD::SGTileDigitsGetterTool, D3PD::SGTileHitGetterTool, D3PD::SGTileModuleBitsGetterTool, and D3PD::SGTileRawChannelGetterTool.

Definition at line 39 of file SGGetterImpl.cxx.

 {
   const std::type_info* ti = 0;
   if (clidToTypeinfo (m_clid, m_typename, ti, this->name()).isSuccess())
     return *ti;
  
   REPORT_MESSAGE (MSG::ERROR) << "Can't find typeinfo for CLID "
                               << m_clid << " (type " << m_typename << ").";
   return typeid (void);
 }

Member Data Documentation

◆ m_athenaPoolCnvSvc

ServiceHandle<IAthenaPoolCnvSvc> D3PD::SGDataVectorGetterTool::m_athenaPoolCnvSvc

private

Used to auto-load converters, if needed.

Definition at line 117 of file SGDataVectorGetterTool.h.

◆ m_backConverter

TypeConverter D3PD::CollectionGetterToolImpl::m_backConverter

privateinherited

Helper to convert pointers back, for releaseElement.

Definition at line 106 of file CollectionGetterToolImpl.h.

◆ m_clid

CLID D3PD::SGGetterImpl::m_clid

privateinherited

CLID for the object being retrieved.

Definition at line 126 of file SGGetterImpl.h.

◆ m_clidsvc

ServiceHandle<IClassIDSvc> D3PD::SGGetterImpl::m_clidsvc

protectedinherited

Property: Instance of the ClassIDSvc to use.

Definition at line 119 of file SGGetterImpl.h.

◆ m_converter

TypeConverter D3PD::SGDataVectorGetterTool::m_converter

private

Converter from the pointer that we get from StoreGate to a pointer to the collection over which we iterate (which may be a base of what we get from SG).

Definition at line 131 of file SGDataVectorGetterTool.h.

◆ m_info

const DataModel_detail::DVLInfoBase* D3PD::SGDataVectorGetterTool::m_info

private

DataVector/List information for this collection.

Definition at line 123 of file SGDataVectorGetterTool.h.

◆ m_it

DataModel_detail::DVLIteratorBase* D3PD::SGDataVectorGetterTool::m_it

private

Current iterator over the collection.

Definition at line 126 of file SGDataVectorGetterTool.h.

◆ m_label

std::string D3PD::CollectionGetterToolImpl::m_label

privateinherited

Property: label to assign to this getter (or null).

Definition at line 97 of file CollectionGetterToolImpl.h.

◆ m_registry

ToolHandle<ICollectionGetterRegistryTool> D3PD::CollectionGetterToolImpl::m_registry

privateinherited

The collection getter registry tool.

Definition at line 100 of file CollectionGetterToolImpl.h.

◆ m_resolver

SGKeyResolver D3PD::SGGetterImpl::m_resolver

protectedinherited

Helper: Resolve the SG key to use.

Definition at line 122 of file SGGetterImpl.h.

◆ m_sg

ServiceHandle<StoreGateSvc>& D3PD::SGGetterImpl::m_sg

privateinherited

The event storage service.

Definition at line 129 of file SGGetterImpl.h.

◆ m_sgkey

std::string D3PD::SGGetterImpl::m_sgkey

protectedinherited

Property: StoreGate key of the object being retrieved.

Definition at line 116 of file SGGetterImpl.h.

◆ m_typename

std::string D3PD::SGGetterImpl::m_typename

protectedinherited

Property: Name of the type of the object being retrieved.

Definition at line 113 of file SGGetterImpl.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SGDataVectorGetterTool()

Member Function Documentation

◆ clid()

◆ configureD3PD()

◆ configureElementTypeinfo()

◆ configureTypeinfo()

◆ DeclareInterfaceID()

◆ elementTypeinfo()

◆ finalize()

◆ get()

◆ getInfo()

◆ getTypeinfo()

◆ getUntyped()

◆ initialize()

◆ initializeImpl()

◆ nextTypeinfo()

◆ nextUntyped()

◆ releaseElementTypeinfo()

◆ releaseObject()

◆ releaseObjectTypeinfo()

◆ releaseObjectUntyped()

◆ reset()

◆ sizeHint()

◆ typeinfo()

Member Data Documentation

◆ m_athenaPoolCnvSvc

◆ m_backConverter

◆ m_clid

◆ m_clidsvc

◆ m_converter

◆ m_info

◆ m_it

◆ m_label

◆ m_registry

◆ m_resolver

◆ m_sg

◆ m_sgkey

◆ m_typename