D3PD::SingleAssociationToolImpl Class Reference

Non-template parts of SingleAssociationTool. More...

#include <SingleAssociationToolImpl.h>

Inherits extends< AthAlgTool, ISingleAssociationTool >, and D3PD::AddVariable.

Inherited by D3PD::IdentityAssociationTool, D3PD::SingleAssociationToolTo< TO_T >, D3PD::SingleAssociationToolTo< AmgSymMatrix(3) >, D3PD::SingleAssociationToolTo< AmgSymMatrix(5) >, D3PD::SingleAssociationToolTo< CLHEP::HepLorentzVector >, D3PD::SingleAssociationToolTo< D3PD::PerigeePair >, D3PD::SingleAssociationToolTo< FROM_T >, D3PD::SingleAssociationToolTo< Obj2 >, D3PD::SingleAssociationToolTo< Trk::Perigee >, D3PD::SingleAssociationToolTo< Trk::TrackParameters >, D3PD::SingleAssociationToolTo< Types< INavigable4Momentum, xAOD::IParticle > >, D3PD::SingleAssociationToolTo< Types< Trk::VxCandidate, xAOD::Vertex > >, D3PD::SingleAssociationToolTo< xAOD::CaloCluster >, D3PD::SingleAssociationToolTo< xAOD::TrackParticle >, D3PD::SingleAssociationToolTo< xAOD::TruthParticle >, and D3PD::SingleAssociationToolTo< xAOD::TruthVertex >.

Collaboration diagram for D3PD::SingleAssociationToolImpl:

Public Member Functions
	SingleAssociationToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor. More...
virtual StatusCode	configureD3PD (D3PD::IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check. More...
virtual StatusCode	book ()
	Create any needed tuple variables. More...
virtual const std::type_info &	fromTypeinfo () const =0
	Return the std::type_info for the source of the association. More...
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree. 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

Non-template parts of SingleAssociationTool.

The class SingleAssociationTool provides a type-safe wrapper for the ISingleAssociationTool interface; it is templated on the types of the source and target of the association. This class serves as a common base class for the SingleAssociationTool instantiations, and factors out all the code that doesn't depend on the template argument.

Derived classes should define fromTypeinfo (this is normally done by SingleAssociationTool). The book method may also be overridden if the tool should itself fill any tuple variables.

Definition at line 44 of file SingleAssociationToolImpl.h.

Constructor & Destructor Documentation

SingleAssociationToolImpl()

D3PD::SingleAssociationToolImpl::SingleAssociationToolImpl	(	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 27 of file SingleAssociationToolImpl.cxx.

  : base_class (type, name, parent),
    AddVariable (m_prefix, m_blockName)
{
  declareProperty ("Prefix", m_prefix = "",
                   "Tuple variable prefix for this block.");
  declareProperty ("BlockName", m_blockName = this->name(),
                   "The name of this block.");
}

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

virtual

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  )

virtual

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  )

protected

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 )

protected

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

virtual const std::type_info& D3PD::SingleAssociationToolImpl::fromTypeinfo ( ) const

pure virtual

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

Implemented in D3PD::SingleAssociationTool< Types< T0 >, TO_T >, D3PD::SingleAssociationTool< FROM_T, TO_T >, and D3PD::IdentityAssociationTool.

Member Data Documentation

m_blockName

std::string D3PD::SingleAssociationToolImpl::m_blockName

private

Property: the name of this block.

Definition at line 121 of file SingleAssociationToolImpl.h.

m_inputConverter

TypeConverter D3PD::SingleAssociationToolImpl::m_inputConverter

private

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

private

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 files:

• SingleAssociationToolImpl.h
• SingleAssociationToolImpl.cxx