Type-safe wrapper for single associator tools. More...

#include <SingleAssociationTool.h>

Inheritance diagram for D3PD::SingleAssociationTool< FROM_T, TO_T >:

Collaboration diagram for D3PD::SingleAssociationTool< FROM_T, TO_T >:

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

virtual const void *	getUntyped (const void *p)
	Return the target object. More...

virtual const std::type_info &	fromTypeinfo () const
	Return the `std::type_info` for the source of the association. More...

virtual const TO_T *	get (const FROM_T &p)=0
	Return the target object. More...

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

virtual void	releaseObject (const typename SelectType< FROM_T, 0 >::type *p)
	Release an object retrieved from the association. More...

virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the association. More...

virtual StatusCode	configureD3PD (D3PD::IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check. More...

StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree. More...

virtual StatusCode	book ()
	Create any needed tuple variables. More...

virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &docstring="", const void defval=0)
	Add a variable to the tuple. More...

template<class T >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Make the template implementation from `IAddVariable` visible. More...

template<class T , class U >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval)
	Make the template implementation from `IAddVariable` visible. More...

virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &docstring="", const void defval=0)=0
	Make the template implementation from `IAddVariable` visible. More...

template<class T >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Add a variable to the tuple. More...

template<class T , class U >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval)
	Add a variable to the tuple. More...

virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &dim, const std::string &docstring="", const void defval=0)
	Add a variable to the tuple. More...

template<class T >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple. More...

template<class T , class U >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple. More...

virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &dim, const std::string &docstring="", const void defval=0)=0
	Add a variable to the tuple. More...

template<class T >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple. More...

template<class T , class U >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple. More...

Protected Member Functions
const void *	doConversion (const void *p)
	Helper to convert pointers to source objects. More...

StatusCode	configureMulti (D3PD::IAddVariable tree, const std::type_info &ti, const std::vector< const std::type_info > &tis, size_t &which)
	Configure during initialization: type-check. More...

Protected Attributes
ObjectMetadata	m_metadata
	Metadata about the variables created by this object. More...

Private Attributes
std::string	m_prefix
	Parameter: source object prefix. More...

std::string	m_blockName
	Property: the name of this block. More...

TypeConverter	m_inputConverter
	Helper to convert source object pointers. More...

const std::string &	m_suffix
	Reference to the variable suffix. More...

IAddVariable *	m_tree
	Reference to the block name. More...

Static Private Attributes
static const std::string	s_emptyString
	Used to provide a default value for blockName. More...

Detailed Description

template<typename FROM_T, typename TO_T = FROM_T>
class D3PD::SingleAssociationTool< FROM_T, TO_T >

Type-safe wrapper for single associator tools.

This can serve as the base class for a single association tool, that associates from one source object to zero or one target objects.

The template arguments give the types of the objects.

Derived classes should define the get() method to carry out the association, and optionally releaseObject().

You may also specify that the tool can take as input any one of a set of types. To do this, use D3PD::Types<...> as the template argument; for example

D3PD::SingleAssociationTool<D3PD::Types<Obj1, Obj2>, Target>

In this case, you should define separate get methods taking both Obj1 and Obj2.

If the output type TO_T is also Types, then the corresponding output type for each input type is taken from it. Examples:

class Assoc1
  : public D3PD::SingleAssociationTool<D3PD::Types<Obj1, Obj2>, Target>
{
  ...
  virtual const Target* get (const Obj1& o) override;
  virtual const Target* get (const Obj2& o) override;
};
 
class Assoc2
  : public D3PD::SingleAssociationTool<D3PD::Types<Obj1, Obj2>,
                                       D3PD::Types<Targ1, Targ2> >
{
  ...
  virtual const Targ1* get (const Obj1& o) override;
  virtual const Targ2* get (const Obj2& o) override;
};

Note that the choice of which input type to use is made once, during configuration; it is not dynamic.

Definition at line 131 of file SingleAssociationTool.h.

Constructor & Destructor Documentation

◆ SingleAssociationTool()

template<typename FROM_T , typename TO_T = FROM_T>

D3PD::SingleAssociationTool< FROM_T, TO_T >::SingleAssociationTool	(	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

◆ addDimensionedVariable() [1/6]

StatusCode D3PD::AddVariable::addDimensionedVariable	(	const std::string &	name,
		const std::type_info &	ti,
		void *&	ptr,
		const std::string &	dim,
		const std::string &	docstring = `""`,
		const void *	defval = `0`
	)

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by `ti`. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Implements D3PD::IAddVariable.

Definition at line 123 of file AddVariable.cxx.

 {
   if (!m_tree) {
     // Called from constructor --- just initialize pointer.
     ptr = 0;
     return StatusCode::SUCCESS;
   }
  
   CHECK( m_metadata.addDimensionedVariable( m_prefix + name + m_suffix,
                                             ti, ptr, dim,
                                             docstring, defval ) );
   return m_tree->addDimensionedVariable (m_prefix + name + m_suffix,
                                          ti, ptr, dim,
                                          docstring, defval);
 }

◆ addDimensionedVariable() [2/6]

virtual StatusCode D3PD::IAddVariable::addDimensionedVariable

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by `ti`. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [3/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	class T	,
		class U
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [4/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	dim,
		const std::string &	docstring,
		const U &	defval
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [5/6]

template<class T >

StatusCode D3PD::IAddVariable::addDimensionedVariable ( class T )

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [6/6]

template<class T >

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	dim,
		const std::string &	docstring = `""`
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ addVariable() [1/6]

StatusCode D3PD::AddVariable::addVariable	(	const std::string &	name,
		const std::type_info &	ti,
		void *&	ptr,
		const std::string &	docstring = `""`,
		const void *	defval = `0`
	)

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by `ti`. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Implements D3PD::IAddVariable.

Definition at line 85 of file AddVariable.cxx.

 {
   if (!m_tree) {
     // Called from constructor --- just initialize pointer.
     ptr = 0;
     return StatusCode::SUCCESS;
   }
  
   CHECK( m_metadata.addVariable( m_prefix + name + m_suffix,
                                  ti, ptr, docstring, defval ) );
   return m_tree->addVariable (m_prefix + name + m_suffix,
                               ti, ptr, docstring, defval);
 }

◆ addVariable() [2/6]

virtual StatusCode D3PD::IAddVariable::addVariable

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addVariable	(	class T	,
		class U
	)

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [4/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	docstring,
		const U &	defval
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addVariable() [5/6]

template<class T >

StatusCode D3PD::IAddVariable::addVariable ( class T )

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [6/6]

template<class T >

StatusCode D3PD::IAddVariable::addVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	docstring = `""`
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ book()

StatusCode D3PD::SingleAssociationToolImpl::book ( )

virtualinherited

Create any needed tuple variables.

This is called at the start of the first event. The default implementation is a no-op.

Reimplemented in D3PD::DRAssociationTool, D3PD::TrackParticleVertexAssociationTool, D3PD::egammaGenParticleAssociationTool, and D3PD::MuonGenParticleAssociationTool.

Definition at line 92 of file SingleAssociationToolImpl.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ configureD3PD() [1/2]

StatusCode D3PD::SingleAssociationToolImpl::configureD3PD	(	D3PD::IAddVariable *	tree,
		const std::type_info &	ti
	)

virtualinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to `getUntyped`.

configureD3PD should check that the type of the object coming as input (to getUntyped) is compatible with what it expects, and raise an error otherwise.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to `resetUntyped`.

configureD3PD should check that the type of the object coming as input (to getUntyped) is compatible with what it expects, and raise an error otherwise.

Reimplemented in D3PD::DRAssociationTool, D3PD::SingleAssociationTool< Types< T0 >, TO_T >, and D3PD::IdentityAssociationTool.

Definition at line 51 of file SingleAssociationToolImpl.cxx.

 {
   CHECK( AddVariable::configureD3PD (tree) );
   CHECK( m_inputConverter.init (ti, fromTypeinfo()) );
   return StatusCode::SUCCESS;
 }

◆ configureD3PD() [2/2]

StatusCode D3PD::AddVariable::configureD3PD ( IAddVariable * tree )

inherited

Configure the parent tree.

Parameters

tree	The parent `IAddVariable` instance.

Definition at line 61 of file AddVariable.cxx.

 {
   m_tree = tree;
   m_metadata.clear();
   return StatusCode::SUCCESS;
 }

◆ configureMulti()

StatusCode D3PD::SingleAssociationToolImpl::configureMulti	(	D3PD::IAddVariable *	tree,
		const std::type_info &	ti,
		const std::vector< const std::type_info * > &	tis,
		size_t &	which
	)

protectedinherited

Configure during initialization: type-check.

Alternate implementation for the case where we have to choose among multiple possible input types.

Parameters

	tree	Our parent for tuple making.
	ti	Gives the type of the object being passed to `getUntyped`.
	tis	List of possible input types that we can accept.
[out]	which	Index of the accepted type.

configureMulti should check that the type of the object coming as input (to getUntyped) is compatible with what it expects, and raise an error otherwise.

Definition at line 74 of file SingleAssociationToolImpl.cxx.

 {
   CHECK( AddVariable::configureD3PD (tree) );
   CHECK( m_inputConverter.init (ti, tis, which) );
   return StatusCode::SUCCESS;
 }

◆ doConversion()

const void * D3PD::SingleAssociationToolImpl::doConversion ( const void * p )

protectedinherited

Helper to convert pointers to source objects.

Parameters

p	Source object, as a pointer to the type passed to `configureD3PD`. return Source object, as a pointer to the type given by `fromTypeinfo`.
p	Source object, as a pointer to the type passed to `configureD3PD`. return Source object, as a pointer to the type given by `typeinfoFrom`.

Definition at line 103 of file SingleAssociationToolImpl.cxx.

 {
   if (!p) return 0;
   const void* pp = m_inputConverter.convertUntyped (p);
   if (!pp) {
     REPORT_MESSAGE (MSG::WARNING)
       << "Pointer conversion from " << m_inputConverter.srcName() << " to "
       << m_inputConverter.dstName() << " failed.";
     return 0;
   }
   return pp;
 }

◆ fromTypeinfo()

template<typename FROM_T , typename TO_T = FROM_T>

virtual const std::type_info& D3PD::SingleAssociationTool< FROM_T, TO_T >::fromTypeinfo ( ) const

virtual

Return the std::type_info for the source of the association.

Implements D3PD::SingleAssociationToolImpl.

◆ get()

template<typename FROM_T , typename TO_T = FROM_T>

virtual const TO_T* D3PD::SingleAssociationTool< FROM_T, TO_T >::get ( const FROM_T & p )

pure virtual

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0.

Implemented in D3PD::TruthParticleProdVertexAssociationTool, D3PD::MuonGenParticleAssociationTool, D3PD::MuonTrackParticleAssociationTool, D3PD::ElectronTrackParticleAssociationTool, D3PD::egammaGenParticleAssociationTool, D3PD::egammaClusterAssociationTool, D3PDTest::IN4MHLVAssociationTool, and D3PD::PerigeePairOldPerigeeAssociationTool.

◆ getUntyped()

template<typename FROM_T , typename TO_T = FROM_T>

virtual const void* D3PD::SingleAssociationTool< FROM_T, TO_T >::getUntyped ( const void * p )

virtual

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0. Should be of the type given by typeinfo.

◆ releaseObject()

virtual void D3PD::SingleAssociationToolTo< FROM_T >::releaseObject ( const typename SelectType< FROM_T , 0 >::type * p )

virtualinherited

Release an object retrieved from the association.

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 association dynamically allocated the object which it returned, this gives it a chance to free it.

◆ releaseObjectUntyped()

virtual void D3PD::SingleAssociationToolTo< FROM_T >::releaseObjectUntyped ( const void * p )

virtualinherited

Release an object retrieved from the association.

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 association dynamically allocated the object which it returned, this gives it a chance to free it.

◆ typeinfo()

virtual const std::type_info& D3PD::SingleAssociationToolTo< FROM_T >::typeinfo

virtualinherited

Return the type of object retrieved by this tool.

Member Data Documentation

◆ m_blockName

std::string D3PD::SingleAssociationToolImpl::m_blockName

privateinherited

Property: the name of this block.

Definition at line 121 of file SingleAssociationToolImpl.h.

◆ m_inputConverter

TypeConverter D3PD::SingleAssociationToolImpl::m_inputConverter

privateinherited

Helper to convert source object pointers.

Definition at line 124 of file SingleAssociationToolImpl.h.

◆ m_metadata

ObjectMetadata D3PD::AddVariable::m_metadata

protectedinherited

Metadata about the variables created by this object.

Definition at line 129 of file AddVariable.h.

◆ m_prefix

std::string D3PD::SingleAssociationToolImpl::m_prefix

privateinherited

Parameter: source object prefix.

Definition at line 118 of file SingleAssociationToolImpl.h.

◆ m_suffix

const std::string& D3PD::AddVariable::m_suffix

privateinherited

Reference to the variable suffix.

Definition at line 137 of file AddVariable.h.

◆ m_tree

IAddVariable* D3PD::AddVariable::m_tree

privateinherited

Reference to the block name.

The parent IAddVariable instance.

Definition at line 143 of file AddVariable.h.

◆ s_emptyString

const std::string D3PD::AddVariable::s_emptyString

staticprivateinherited

Used to provide a default value for blockName.

Definition at line 41 of file AddVariable.h.

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

SingleAssociationTool.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

template<typename FROM_T, typename TO_T = FROM_T> class D3PD::SingleAssociationTool< FROM_T, TO_T >

Constructor & Destructor Documentation

◆ SingleAssociationTool()

Member Function Documentation

◆ addDimensionedVariable() [1/6]

◆ addDimensionedVariable() [2/6]

◆ addDimensionedVariable() [3/6]

◆ addDimensionedVariable() [4/6]

◆ addDimensionedVariable() [5/6]

◆ addDimensionedVariable() [6/6]

◆ addVariable() [1/6]

◆ addVariable() [2/6]

◆ addVariable() [3/6]

◆ addVariable() [4/6]

◆ addVariable() [5/6]

◆ addVariable() [6/6]

◆ book()

◆ configureD3PD() [1/2]

◆ configureD3PD() [2/2]

◆ configureMulti()

◆ doConversion()

◆ fromTypeinfo()

◆ get()

◆ getUntyped()

◆ releaseObject()

◆ releaseObjectUntyped()

◆ typeinfo()

Member Data Documentation

◆ m_blockName

◆ m_inputConverter

◆ m_metadata

◆ m_prefix

◆ m_suffix

◆ m_tree

◆ s_emptyString

template<typename FROM_T, typename TO_T = FROM_T>
class D3PD::SingleAssociationTool< FROM_T, TO_T >