#include <IParticleLinksCollectionGetterTool.h>

Inheritance diagram for D3PD::IParticleLinksCollectionGetterTool:

Collaboration diagram for D3PD::IParticleLinksCollectionGetterTool:

Public Types
typedef SGCollectionGetterTool< IParticleLinks >	Base

Public Member Functions
	IParticleLinksCollectionGetterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor. More...

virtual StatusCode	initialize ()
	Standard Gaudi initialize method. More...

virtual const std::type_info &	typeinfo () const
	Return the type of object retrieved by this tool. More...

virtual const std::type_info &	typeinfo () const
	Return the type of object retrieved by this tool. More...

virtual const void *	getUntyped (bool allowMissing=false)
	Return the target object. More...

virtual const IParticleLinks *	get (bool allowMissing=false)
	Type-safe wrapper for `get`. More...

CLID	clid () const
	Return the class ID being read by this tool. More...

	DeclareInterfaceID (IObjGetterTool, 1, 0)
	Gaudi interface definition. More...

virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the getter. 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...

virtual void	releaseObject (const IParticleLinks *p)
	Release an object retrieved from the getter. 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...

virtual const std::type_info &	elementTypeinfo () const
	Return the element type of the collection. More...

virtual StatusCode	reset (bool allowMissing=false)
	Reset the iteration to the start of the collection. More...

virtual const void *	nextUntyped ()
	Return a pointer to the next element in the collection. More...

virtual size_t	sizeHint (bool allowMissing=false)
	Return an estimate of the number of elements in the iteration. More...

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

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

CONT::const_iterator	m_it
	The current iterator. More...

CONT::const_iterator	m_end
	The iterator at the end of the container. More...

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

Definition at line 28 of file IParticleLinksCollectionGetterTool.h.

Member Typedef Documentation

◆ Base

typedef SGCollectionGetterTool<IParticleLinks> D3PD::IParticleLinksCollectionGetterTool::Base

Definition at line 32 of file IParticleLinksCollectionGetterTool.h.

Constructor & Destructor Documentation

◆ IParticleLinksCollectionGetterTool()

D3PD::IParticleLinksCollectionGetterTool::IParticleLinksCollectionGetterTool	(	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 26 of file IParticleLinksCollectionGetterTool.cxx.

     : Base (type, name, parent)
 {
   m_typename = "IParticleLinks";
 }

Member Function Documentation

◆ clid()

CLID D3PD::SGGetterImpl::clid ( ) const

inherited

Return the class ID being read by this tool.

Definition at line 54 of file SGGetterImpl.cxx.

 {
   return m_clid;
 }

◆ CollectionGetterToolImpl()

D3PD::CollectionGetterToolImpl::CollectionGetterToolImpl

inherited

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

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

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

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

◆ elementTypeinfo()

virtual const std::type_info& D3PD::CollectionGetterTool< IParticleLinks >::elementTypeinfo

virtualinherited

Return the element type of the collection.

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

◆ get()

virtual const IParticleLinks * D3PD::SGCollectionGetterTool< IParticleLinks >::get ( bool allowMissing = false )

virtualinherited

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.

Implements D3PD::CollectionGetterTool< IParticleLinks >.

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

virtual const void* D3PD::SGCollectionGetterTool< IParticleLinks >::getUntyped ( bool allowMissing = false )

virtualinherited

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.

Reimplemented from D3PD::SGGetterImpl.

◆ initialize()

virtual StatusCode D3PD::SGCollectionGetterTool< IParticleLinks >::initialize

virtualinherited

Standard Gaudi initialize method.

◆ initializeImpl()

StatusCode D3PD::SGGetterImpl::initializeImpl ( )

protectedinherited

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

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

virtual const void* D3PD::CollectionGetterTool< IParticleLinks >::nextUntyped

virtualinherited

Return a pointer to the next element in the collection.

Return 0 when the collection has been exhausted.

◆ 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() [1/2]

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

◆ releaseObject() [2/2]

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() [1/2]

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.

◆ releaseObjectUntyped() [2/2]

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

◆ reset()

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

virtualinherited

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.

◆ sizeHint()

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

virtualinherited

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

◆ typeinfo() [1/2]

virtual const std::type_info& D3PD::SGCollectionGetterTool< IParticleLinks >::typeinfo

virtualinherited

Return the type of object retrieved by this tool.

Reimplemented from D3PD::CollectionGetterTool< IParticleLinks >.

◆ typeinfo() [2/2]

const std::type_info & D3PD::SGGetterImpl::typeinfo ( ) const

virtualinherited

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_backConverter

TypeConverter D3PD::CollectionGetterToolImpl::m_backConverter

privateinherited

Helper to convert pointers back, for releaseElement.

Definition at line 106 of file CollectionGetterToolImpl.h.

◆ m_clid

CLID D3PD::SGGetterImpl::m_clid

privateinherited

CLID for the object being retrieved.

Definition at line 126 of file SGGetterImpl.h.

◆ m_clidsvc

ServiceHandle<IClassIDSvc> D3PD::SGGetterImpl::m_clidsvc

protectedinherited

Property: Instance of the ClassIDSvc to use.

Definition at line 119 of file SGGetterImpl.h.

◆ m_converter

TypeConverter D3PD::CollectionGetterToolImpl::m_converter

privateinherited

Helper to convert pointers.

Definition at line 103 of file CollectionGetterToolImpl.h.

◆ m_end

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

privateinherited

The iterator at the end of the container.

Definition at line 143 of file CollectionGetterTool.h.

◆ m_it

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

privateinherited

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.

◆ m_resolver

SGKeyResolver D3PD::SGGetterImpl::m_resolver

protectedinherited

Helper: Resolve the SG key to use.

Definition at line 122 of file SGGetterImpl.h.

◆ m_sg

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

privateinherited

The event storage service.

Definition at line 129 of file SGGetterImpl.h.

◆ m_sgkey

std::string D3PD::SGGetterImpl::m_sgkey

protectedinherited

Property: StoreGate key of the object being retrieved.

Definition at line 116 of file SGGetterImpl.h.

◆ m_typename

std::string D3PD::SGGetterImpl::m_typename

protectedinherited

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 Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ IParticleLinksCollectionGetterTool()

Member Function Documentation

◆ clid()

◆ CollectionGetterToolImpl()

◆ configureD3PD()

◆ configureElementTypeinfo()

◆ configureTypeinfo()

◆ DeclareInterfaceID()

◆ elementTypeinfo()

◆ get()

◆ getTypeinfo()

◆ getUntyped()

◆ initialize()

◆ initializeImpl()

◆ nextTypeinfo()

◆ nextUntyped()

◆ releaseElementTypeinfo()

◆ releaseObject() [1/2]

◆ releaseObject() [2/2]

◆ releaseObjectTypeinfo()

◆ releaseObjectUntyped() [1/2]

◆ releaseObjectUntyped() [2/2]

◆ reset()

◆ sizeHint()

◆ typeinfo() [1/2]

◆ typeinfo() [2/2]

Member Data Documentation

◆ m_backConverter

◆ m_clid

◆ m_clidsvc

◆ m_converter

◆ m_end

◆ m_it

◆ m_label

◆ m_registry

◆ m_resolver

◆ m_sg

◆ m_sgkey

◆ m_typename