D3PD::CollectionGetterToolImpl Class Reference

Non-template parts of CollectionGetterTool. More...

#include <CollectionGetterToolImpl.h>

Inherits extends1< ObjGetterToolImpl, ICollectionGetterTool >.

Inherited by D3PD::CollectionGetterTool< CaloCalibrationHitContainer >, D3PD::CollectionGetterTool< INav4MomLinkContainer >, D3PD::CollectionGetterTool< IParticleLinks >, D3PD::CollectionGetterTool< LArHitContainer >, D3PD::CollectionGetterTool< LArRawChannelContainer >, D3PD::CollectionGetterTool< Obj4Container >, D3PD::CollectionGetterTool< TileDigitsContainer >, D3PD::CollectionGetterTool< TileHitVector >, D3PD::CollectionGetterTool< TileRawChannelContainer >, D3PD::CollectionGetterTool< TrackRecordCollection >, D3PD::CollectionGetterFilterToolImpl, D3PD::CollectionGetterTool< CONT >, and D3PD::SGDataVectorGetterTool.

Collaboration diagram for D3PD::CollectionGetterToolImpl:

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

Private Attributes
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_converter
	Helper to convert pointers. More...
TypeConverter	m_backConverter
	Helper to convert pointers back, for releaseElement. More...

Detailed Description

Non-template parts of CollectionGetterTool.

CollectionGetterTool extends ObjGetterTool to allow iterating over the objects within a container. CollectionGetterTool is templated on the collection type. This class factors out the pieces that don't depend on the template argument.

Definition at line 40 of file CollectionGetterToolImpl.h.

Constructor & Destructor Documentation

CollectionGetterToolImpl()

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

  : base_class (type, name, parent)
{
  declareProperty ("Label", m_label,
                   "Label to assign to this getter, to be able to reference "
                   "it from an association tool.  Leave blank if no label "
                   "is needed.");
  declareProperty ("CollectionGetterRegistry", m_registry,
                   "Collection getter registry tool");
}

Member Function Documentation

configureElementTypeinfo()

StatusCode D3PD::CollectionGetterToolImpl::configureElementTypeinfo

(

const std::type_info &

ti

)

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

initialize()

StatusCode D3PD::CollectionGetterToolImpl::initialize

(

)

Standard Gaudi initialize method.

Definition at line 45 of file CollectionGetterToolImpl.cxx.

{
  // If a label was provided, add ourselves to the registry.
  if (!m_label.empty()) {
    CHECK( m_registry.retrieve() );
    CHECK( m_registry->add (m_label, this) );
  }
  else {
    m_registry.disable();
  }
  return ObjGetterToolImpl::initialize();
}

nextTypeinfo()

const void * D3PD::CollectionGetterToolImpl::nextTypeinfo

(

const std::type_info &

ti

)

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

releaseElementTypeinfo()

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

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

Member Data Documentation

m_backConverter

TypeConverter D3PD::CollectionGetterToolImpl::m_backConverter

private

Helper to convert pointers back, for releaseElement.

Definition at line 106 of file CollectionGetterToolImpl.h.

m_converter

TypeConverter D3PD::CollectionGetterToolImpl::m_converter

private

Helper to convert pointers.

Definition at line 103 of file CollectionGetterToolImpl.h.

m_label

std::string D3PD::CollectionGetterToolImpl::m_label

private

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

private

The collection getter registry tool.

Definition at line 100 of file CollectionGetterToolImpl.h.

---

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

• CollectionGetterToolImpl.h
• CollectionGetterToolImpl.cxx