Getter tool to retrieve single objects from StoreGate. More...

#include <SGObjGetterTool.h>

Inheritance diagram for D3PD::SGObjGetterTool:

Collaboration diagram for D3PD::SGObjGetterTool:

Public Member Functions
	SGObjGetterTool (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 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...

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

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

void	releaseObjectTypeinfo (const void *p, const std::type_info &ti)
	Release an object 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 Attributes
CLID	m_clid
	CLID for the object being retrieved. More...

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

TypeConverter	m_converter
	Helper to convert pointers. More...

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

Detailed Description

Getter tool to retrieve single objects from StoreGate.

This is a Getter tool that retrieves a single object from StoreGate, given the type name and SG key. This class should be able to handle any type that can be put into StoreGate.

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 46 of file SGObjGetterTool.h.

Constructor & Destructor Documentation

◆ SGObjGetterTool()

D3PD::SGObjGetterTool::SGObjGetterTool	(	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 28 of file SGObjGetterTool.cxx.

   : SGGetterImpl (name, evtStore()),
     ObjGetterToolImpl (type, name, parent)
 {
   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.

◆ configureTypeinfo() [1/2]

StatusCode D3PD::ObjGetterToolImpl::configureTypeinfo ( const std::type_info & ti )

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.

Definition at line 124 of file ObjGetterToolImpl.cxx.

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

◆ configureTypeinfo() [2/2]

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.

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

◆ getTypeinfo() [1/2]

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

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.

Definition at line 45 of file ObjGetterToolImpl.cxx.

 {
   // Configure the converter if needed.
   if (!this->m_converter.isValid() ||
       this->m_converter.dstTypeinfo() != ti)
   {
     if (this->configureTypeinfo(ti).isFailure())
       return 0;
   }
  
   // Get the object.
   const void* p = this->getUntyped (allowMissing);
  
   // Convert to the desired type.
   if (p) {
     p = this->m_converter.convertUntyped (p);
     if (!p) {
       REPORT_MESSAGE (MSG::WARNING)
         << "Pointer conversion from " << m_converter.srcName() << " to "
         << m_converter.dstName() << "failed.";
     }
   }
   return p;
 }

◆ getTypeinfo() [2/2]

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::SGObjGetterTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 41 of file SGObjGetterTool.cxx.

 {
   CHECK( SGGetterImpl::initializeImpl() );
   return AthAlgTool::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;
 }

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

void D3PD::ObjGetterToolImpl::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.

Definition at line 82 of file ObjGetterToolImpl.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->releaseObjectUntyped (p);
   else {
     REPORT_MESSAGE (MSG::WARNING)
       << "Pointer conversion from " << m_backConverter.srcName() << " to "
       << m_backConverter.dstName() << "failed.";
   }
 }

◆ releaseObjectTypeinfo() [2/2]

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.

◆ 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_backConverter

TypeConverter D3PD::ObjGetterToolImpl::m_backConverter

privateinherited

Helper to convert pointers back, for releaseObject.

Definition at line 97 of file ObjGetterToolImpl.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::ObjGetterToolImpl::m_converter

privateinherited

Helper to convert pointers.

Definition at line 94 of file ObjGetterToolImpl.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 Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SGObjGetterTool()

Member Function Documentation

◆ clid()

◆ configureD3PD()

◆ configureTypeinfo() [1/2]

◆ configureTypeinfo() [2/2]

◆ DeclareInterfaceID()

◆ get()

◆ getTypeinfo() [1/2]

◆ getTypeinfo() [2/2]

◆ getUntyped()

◆ initialize()

◆ initializeImpl()

◆ releaseObject()

◆ releaseObjectTypeinfo() [1/2]

◆ releaseObjectTypeinfo() [2/2]

◆ releaseObjectUntyped()

◆ typeinfo()

Member Data Documentation

◆ m_backConverter

◆ m_clid

◆ m_clidsvc

◆ m_converter

◆ m_resolver

◆ m_sg

◆ m_sgkey

◆ m_typename