Type-safe wrapper for ICollectionGetterTool. More...

#include <CollectionGetterTool.h>

Inheritance diagram for D3PD::CollectionGetterTool< CONT >:

Collaboration diagram for D3PD::CollectionGetterTool< CONT >:

Public Member Functions
virtual const void *	getUntyped (bool allowMissing=false)
	Return the target object.
virtual const std::type_info &	typeinfo () const
	Return the type of the collection object retrieved by this tool.
virtual const std::type_info &	elementTypeinfo () const
	Return the element type of the collection.
virtual StatusCode	reset (bool allowMissing=false)
	Reset the iteration to the start of the collection.
virtual const void *	nextUntyped ()
	Return a pointer to the next element in the collection.
virtual size_t	sizeHint (bool allowMissing=false)
	Return an estimate of the number of elements in the iteration.
virtual const CONT *	get (bool allowMissing=false)=0
	Return the collection object.
virtual void	releaseObject (const CONT *p)
	Release an object retrieved from the getter.
virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the getter.
	CollectionGetterToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
StatusCode	initialize ()
	Standard Gaudi `initialize` method.
const void *	nextTypeinfo (const std::type_info &ti)
	Return the next object cast to a different pointer type.
StatusCode	configureElementTypeinfo (const std::type_info &ti)
	Test type compatibility.
void	releaseElementTypeinfo (const void *p, const std::type_info &ti)
	Release an element retrieved from the getter.

Private Attributes
CONT::const_iterator	m_it
	The current iterator.
CONT::const_iterator	m_end
	The iterator at the end of the container.
std::string	m_label
	Property: label to assign to this getter (or null).
ToolHandle< ICollectionGetterRegistryTool >	m_registry
	The collection getter registry tool.
TypeConverter	m_converter
	Helper to convert pointers.
TypeConverter	m_backConverter
	Helper to convert pointers back, for `releaseElement`.

Detailed Description

template<class CONT>
class D3PD::CollectionGetterTool< CONT >

Type-safe wrapper for ICollectionGetterTool.

The template argument gives the type of the container that we're returning. This class implements the iteration over the container. If your container obeys the standard iteration protocol (for a forward_iterator), then you just need to derive from this class and implement get(), and optionally releaseObject().

Definition at line 35 of file CollectionGetterTool.h.

Member Function Documentation

◆ CollectionGetterToolImpl()

template<class CONT>

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

◆ configureElementTypeinfo()

StatusCode D3PD::CollectionGetterToolImpl::configureElementTypeinfo ( const std::type_info & ti )

inherited

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

◆ elementTypeinfo()

template<class CONT>

virtual const std::type_info & D3PD::CollectionGetterTool< CONT >::elementTypeinfo ( ) const

virtual

Return the element type of the collection.

I.e., nextUntyped returns a pointer to this type.

Reimplemented in D3PD::SGTileDigitsGetterTool, D3PD::SGTileHitGetterTool, D3PD::SGTileModuleBitsGetterTool, and D3PD::SGTileRawChannelGetterTool.

◆ get()

template<class CONT>

virtual const CONT * D3PD::CollectionGetterTool< CONT >::get ( bool allowMissing = false )

pure virtual

Return the collection object.

Return 0 on failure.

Parameters

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

◆ getUntyped()

template<class CONT>

virtual const void * D3PD::CollectionGetterTool< CONT >::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.

This is implemented by calling get().

◆ initialize()

StatusCode D3PD::CollectionGetterToolImpl::initialize ( )

inherited

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 )

inherited

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

◆ nextUntyped()

template<class CONT>

virtual const void * D3PD::CollectionGetterTool< CONT >::nextUntyped ( )

virtual

Return a pointer to the next element in the collection.

Return 0 when the collection has been exhausted.

Reimplemented in D3PD::SGTileDigitsGetterTool, D3PD::SGTileHitGetterTool, D3PD::SGTileModuleBitsGetterTool, and D3PD::SGTileRawChannelGetterTool.

◆ releaseElementTypeinfo()

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

inherited

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

◆ releaseObject()

template<class CONT>

virtual void D3PD::CollectionGetterTool< CONT >::releaseObject ( const CONT * 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.

◆ releaseObjectUntyped()

template<class CONT>

virtual void D3PD::CollectionGetterTool< CONT >::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.

◆ reset()

template<class CONT>

virtual StatusCode D3PD::CollectionGetterTool< CONT >::reset ( bool allowMissing = false )

virtual

Reset the iteration to the start of the collection.

Parameters

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

Return failure if the container cannot be retrieved.

Reimplemented in D3PD::SGTileDigitsGetterTool, D3PD::SGTileHitGetterTool, D3PD::SGTileModuleBitsGetterTool, and D3PD::SGTileRawChannelGetterTool.

◆ sizeHint()

template<class CONT>

virtual size_t D3PD::CollectionGetterTool< CONT >::sizeHint ( bool allowMissing = false )

virtual

Return an estimate of the number of elements in the iteration.

Parameters

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

This can be used to pre-allocate memory. (It's possible that this isn't known in advance of iterating over the entire collection, for example if a selection is being applied, so this is only a hint.)

Reimplemented in D3PD::SGTileDigitsGetterTool, D3PD::SGTileHitGetterTool, D3PD::SGTileModuleBitsGetterTool, and D3PD::SGTileRawChannelGetterTool.

◆ typeinfo()

template<class CONT>

virtual const std::type_info & D3PD::CollectionGetterTool< CONT >::typeinfo ( ) const

virtual

Return the type of the collection object retrieved by this tool.

Member Data Documentation

◆ m_backConverter

TypeConverter D3PD::CollectionGetterToolImpl::m_backConverter

privateinherited

Helper to convert pointers back, for releaseElement.

Definition at line 106 of file CollectionGetterToolImpl.h.

◆ m_converter

TypeConverter D3PD::CollectionGetterToolImpl::m_converter

privateinherited

Helper to convert pointers.

Definition at line 103 of file CollectionGetterToolImpl.h.

◆ m_end

template<class CONT>

CONT::const_iterator D3PD::CollectionGetterTool< CONT >::m_end

private

The iterator at the end of the container.

Definition at line 143 of file CollectionGetterTool.h.

◆ m_it

template<class CONT>

CONT::const_iterator D3PD::CollectionGetterTool< CONT >::m_it

private

The current iterator.

Definition at line 140 of file CollectionGetterTool.h.

◆ m_label

std::string D3PD::CollectionGetterToolImpl::m_label

privateinherited

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

privateinherited

The collection getter registry tool.

Definition at line 100 of file CollectionGetterToolImpl.h.

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

CollectionGetterTool.h

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ CollectionGetterToolImpl()

◆ configureElementTypeinfo()

◆ elementTypeinfo()

◆ get()

◆ getUntyped()

◆ initialize()

◆ nextTypeinfo()

◆ nextUntyped()

◆ releaseElementTypeinfo()

◆ releaseObject()

◆ releaseObjectUntyped()

◆ reset()

◆ sizeHint()

◆ typeinfo()

Member Data Documentation

◆ m_backConverter

◆ m_converter

◆ m_end

◆ m_it

◆ m_label

◆ m_registry