D3PD::ObjGetterToolImpl Class Reference

Non-template parts of ObjGetterTool. More...

#include <ObjGetterToolImpl.h>

Inheritance diagram for D3PD::ObjGetterToolImpl:

Collaboration diagram for D3PD::ObjGetterToolImpl:

Public Member Functions
	ObjGetterToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
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

Non-template parts of ObjGetterTool.

The class ObjGetterTool provides a type-safe wrapper for the IObjGetterTool interface; it is templated on the type of object on which it retrieves. This class serves as a common base class for the ObjGetterToolTool instantiations, and factors out all the code that doesn't depend on the template argument. It may also be useful for other getter classes that don't use ObjGetterTool.

Definition at line 39 of file ObjGetterToolImpl.h.

Constructor & Destructor Documentation

ObjGetterToolImpl()

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

  : base_class (type, name, parent)
{
}

Member Function Documentation

configureTypeinfo()

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

virtual

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

getTypeinfo()

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

virtual

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

releaseObjectTypeinfo()

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

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

Member Data Documentation

m_backConverter

TypeConverter D3PD::ObjGetterToolImpl::m_backConverter

private

Helper to convert pointers back, for releaseObject.

Definition at line 97 of file ObjGetterToolImpl.h.

m_converter

TypeConverter D3PD::ObjGetterToolImpl::m_converter

private

Helper to convert pointers.

Definition at line 94 of file ObjGetterToolImpl.h.

---

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

• ObjGetterToolImpl.h
• ObjGetterToolImpl.cxx