D3PD::ObjGetterTool< T > Class Template Reference

This is a type-safe wrapper for the IObjGetterTool interface. More...

#include <ObjGetterTool.h>

Inheritance diagram for D3PD::ObjGetterTool< T >:

Collaboration diagram for D3PD::ObjGetterTool< T >:

Public Member Functions
	ObjGetterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual const void *	getUntyped (bool allowMissing=false)
	Return the target object.
virtual const std::type_info &	typeinfo () const
	Return the type of object retrieved by this tool.
virtual const T *	get (bool allowMissing=false)=0
	Return the target object.
virtual void	releaseObject (const T *p)
	Release an object retrieved from the getter.
virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the getter.
virtual const void *	getTypeinfo (const std::type_info &ti, bool allowMissing=false)
	Return the target object cast to a different pointer type.
virtual StatusCode	configureTypeinfo (const std::type_info &ti)
	Test type compatibility.
void	releaseObjectTypeinfo (const void *p, const std::type_info &ti)
	Release an object retrieved from the getter.

Private Attributes
TypeConverter	m_converter
	Helper to convert pointers.
TypeConverter	m_backConverter
	Helper to convert pointers back, for releaseObject.

Detailed Description

template<class T>
class D3PD::ObjGetterTool< T >

This is a type-safe wrapper for the IObjGetterTool interface.

The template argument gives the type of object being retrieved. Derived classes should implement the get() method, to retrieve an object, and optionally releaseObject() to dispose of an object.

Definition at line 34 of file ObjGetterTool.h.

Constructor & Destructor Documentation

ObjGetterTool()

template<class T>

D3PD::ObjGetterTool< T >::ObjGetterTool	(	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.

Member Function Documentation

configureTypeinfo()

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

get()

template<class T>

virtual const T * D3PD::ObjGetterTool< T >::get ( bool allowMissing = false )

pure virtual

Return the target object.

Parameters

allowMissing

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

Return 0 on failure.

getTypeinfo()

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

getUntyped()

template<class T>

virtual const void * D3PD::ObjGetterTool< T >::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.

releaseObject()

template<class T>

virtual void D3PD::ObjGetterTool< T >::releaseObject ( const T * p )

virtual

Release an object retrieved from the getter.

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.

releaseObjectTypeinfo()

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

releaseObjectUntyped()

template<class T>

virtual void D3PD::ObjGetterTool< T >::releaseObjectUntyped ( const void * p )

virtual

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

template<class T>

virtual const std::type_info & D3PD::ObjGetterTool< T >::typeinfo ( ) const

virtual

Return the type of object retrieved by this tool.

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_converter

TypeConverter D3PD::ObjGetterToolImpl::m_converter

privateinherited

Helper to convert pointers.

Definition at line 94 of file ObjGetterToolImpl.h.

---

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

• ObjGetterTool.h