Common object getter code for retrieving from StoreGate. More...

#include <SGGetterImpl.h>

Collaboration diagram for D3PD::SGGetterImpl:

Public Member Functions
	SGGetterImpl (const std::string &name, ServiceHandle< StoreGateSvc > &sg)
	Constructor. 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...

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

Detailed Description

Common object getter code for retrieving from StoreGate.

This class fulfills part of the IObjGetterTool interface, fetching an object from StoreGate. It's structured as a mixin class, so it can be used both for single-object and container getter tools.

This class uses a few properties, but since it's a mixin (and doesn't derive from AlgTool) it can't declare the properties itself. Instead, it defines the macro SGGETTERIMPL_PROPS, which should be used in the constructor of the derived AlgTool class. You should also call initializeImpl() from initialize().

The object being retrieved is specified by the properties TypeName and SGKey. SGKey may be a comma or space-separated list; the first entry that's actually present in the event store will be used. In addition, the property ClassIDSvc may be used to specify the instance of this service.

Definition at line 50 of file SGGetterImpl.h.

Constructor & Destructor Documentation

◆ SGGetterImpl()

D3PD::SGGetterImpl::SGGetterImpl	(	const std::string &	name,
		ServiceHandle< StoreGateSvc > &	sg
	)

Constructor.

Parameters

name	Name of this tool.
sg	The event storage service.

Definition at line 26 of file SGGetterImpl.cxx.

   : m_clidsvc ("ClassIDSvc", name),
     m_resolver (name, sg, m_sgkey),
     m_clid (CLID_NULL),
     m_sg (sg)
 {
 }

Member Function Documentation

◆ clid()

CLID D3PD::SGGetterImpl::clid ( ) const

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

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

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 )

virtual

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;
 }

◆ initializeImpl()

StatusCode D3PD::SGGetterImpl::initializeImpl ( )

protected

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

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

virtual

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_clid

CLID D3PD::SGGetterImpl::m_clid

private

CLID for the object being retrieved.

Definition at line 126 of file SGGetterImpl.h.

◆ m_clidsvc

ServiceHandle<IClassIDSvc> D3PD::SGGetterImpl::m_clidsvc

protected

Property: Instance of the ClassIDSvc to use.

Definition at line 119 of file SGGetterImpl.h.

◆ m_resolver

SGKeyResolver D3PD::SGGetterImpl::m_resolver

protected

Helper: Resolve the SG key to use.

Definition at line 122 of file SGGetterImpl.h.

◆ m_sg

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

private

The event storage service.

Definition at line 129 of file SGGetterImpl.h.

◆ m_sgkey

std::string D3PD::SGGetterImpl::m_sgkey

protected

Property: StoreGate key of the object being retrieved.

Definition at line 116 of file SGGetterImpl.h.

◆ m_typename

std::string D3PD::SGGetterImpl::m_typename

protected

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

◆ SGGetterImpl()

Member Function Documentation

◆ clid()

◆ configureD3PD()

◆ configureTypeinfo()

◆ DeclareInterfaceID()

◆ get()

◆ getTypeinfo()

◆ getUntyped()

◆ initializeImpl()

◆ releaseObject()

◆ releaseObjectTypeinfo()

◆ releaseObjectUntyped()

◆ typeinfo()

Member Data Documentation

◆ m_clid

◆ m_clidsvc

◆ m_resolver

◆ m_sg

◆ m_sgkey

◆ m_typename