A specialization of SingleAssociationTool that can accept one of several types. More...

#include <SingleAssociationToolMulti.h>

Inheritance diagram for D3PD::SingleAssociationTool< Types< T0 >, TO_T >:

Collaboration diagram for D3PD::SingleAssociationTool< Types< T0 >, TO_T >:

Public Member Functions
	SingleAssociationTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti) override
	Configure during initialization: type-check.
virtual const void *	getUntyped (const void *p) override
	Return the target object.
virtual const std::type_info &	fromTypeinfo () const override
	Return the `std::type_info` for the source of the association.
virtual const SelectType< TO_T, 0 >::type *	get (const T0 &p)=0
	Return the target object.
virtual const std::type_info &	typeinfo () const override
	Return the type of object retrieved by this tool.
virtual void	releaseObject (const typename SelectType< TO_T, 0 >::type *) override
	Release an object retrieved from the association.
virtual void	releaseObjectUntyped (const void *p) override
	Release an object retrieved from the association.
virtual const std::type_info &	typeinfo () const
	Return the type of object retrieved by this tool.
virtual void	releaseObject (const typename SelectType< Types< T0 >, 0 >::type *p)
	Release an object retrieved from the association.
virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the association.
virtual StatusCode	configureD3PD (D3PD::IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check.
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree.
virtual StatusCode	book ()
	Create any needed tuple variables.
virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void &ptr, std::string_view docstring="", const void defval=0)
	Add a variable to the tuple.
StatusCode	addVariable (const std::string &name, T *&ptr, std::string_view docstring="")
	Make the template implementation from `IAddVariable` visible.
StatusCode	addVariable (const std::string &name, T *&ptr, std::string_view docstring, const U &defval)
	Make the template implementation from `IAddVariable` visible.
virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &dim, std::string_view docstring="", const void defval=0)
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, std::string_view docstring="")
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, std::string_view docstring, const U &defval)
	Add a variable to the tuple.

Protected Member Functions
virtual const void *	doGetUntyped (const void *p, size_t count)
	Helper to decide which which `get` method to call.
virtual void	doReleaseObjectUntyped (const void *p, size_t count)
virtual void	push_ti (std::vector< const std::type_info * > &tis)
	Helper to collect the list of `type_info's` that we accept.
virtual const std::type_info &	doTypeinfo (size_t count) const
const void *	doConversion (const void *p)
	Helper to convert pointers to source objects.
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.

Protected Attributes
size_t	m_which
	Index of which type we're expecting.
ObjectMetadata	m_metadata
	Metadata about the variables created by this object.

Private Attributes
const std::type_info *	m_fromTypeinfo
	`type_info` for the selected type.
std::string	m_prefix
	Parameter: source object prefix.
std::string	m_blockName
	Property: the name of this block.
TypeConverter	m_inputConverter
	Helper to convert source object pointers.
const std::string &	m_suffix
	Reference to the variable suffix.
IAddVariable *	m_tree
	The parent `IAddVariable` instance.

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

Detailed Description

template<class T0, class TO_T>
class D3PD::SingleAssociationTool< Types< T0 >, TO_T >

A specialization of SingleAssociationTool that can accept one of several types.

The input for this tool can either be of type T1 ... T5. The first one that yields a valid conversion is used, and the appropriate get method is called.

If the output type is also a Types construct, then the corresponding type within that is used as the output type.

Note that this is all done at configuration time: this doesn't allow the type to change dynamically. Rather, this gives a tool that can be configured with more than one type.

This specialization is for the 1-argument case.

Definition at line 49 of file SingleAssociationToolMulti.h.

Constructor & Destructor Documentation

◆ SingleAssociationTool()

template<class T0, class TO_T>

D3PD::SingleAssociationTool< Types< T0 >, 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/3]

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

virtual

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.

Definition at line 119 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/3]

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

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

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

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/3]

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

virtual

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.

Definition at line 93 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/3]

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

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/3]

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

Make the template implementation from IAddVariable visible.

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

Definition at line 79 of file SingleAssociationToolImpl.cxx.

{
  return StatusCode::SUCCESS;
}

◆ configureD3PD() [1/3]

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.

Definition at line 69 of file SingleAssociationToolImpl.cxx.

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

◆ configureD3PD() [2/3]

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

Configure the parent tree.

Parameters

tree	The parent `IAddVariable` instance.

Definition at line 69 of file AddVariable.cxx.

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

◆ configureD3PD() [3/3]

template<class T0, class TO_T>

virtual StatusCode D3PD::SingleAssociationTool< Types< T0 >, TO_T >::configureD3PD	(	IAddVariable *	tree,
		const std::type_info &	ti )

overridevirtual

Configure during initialization: type-check.

Parameters

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

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

Reimplemented from D3PD::SingleAssociationToolImpl.

◆ 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 110 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 94 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;
}

◆ doGetUntyped()

template<class T0, class TO_T>

virtual const void * D3PD::SingleAssociationTool< Types< T0 >, TO_T >::doGetUntyped	(	const void *	p,
		size_t	count )

protectedvirtual

Helper to decide which which get method to call.

This either calls get using the last type in our template argument list, or chains to the base class.

It's virtual so that we can call the most-derived one from getUntyped in the base class, but we also declare it as inline so that the base class chaining can be inlined.

◆ doReleaseObjectUntyped()

template<class T0, class TO_T>

virtual void D3PD::SingleAssociationTool< Types< T0 >, TO_T >::doReleaseObjectUntyped	(	const void *	p,
		size_t	count )

protectedvirtual

◆ doTypeinfo()

template<class T0, class TO_T>

virtual const std::type_info & D3PD::SingleAssociationTool< Types< T0 >, TO_T >::doTypeinfo ( size_t count ) const

protectedvirtual

◆ fromTypeinfo()

template<class T0, class TO_T>

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

overridevirtual

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

Implements D3PD::SingleAssociationToolImpl.

◆ get()

template<class T0, class TO_T>

virtual const SelectType< TO_T, 0 >::type * D3PD::SingleAssociationTool< Types< T0 >, TO_T >::get ( const T0 & p )

pure virtual

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0.

◆ getUntyped()

template<class T0, class TO_T>

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

overridevirtual

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.

◆ push_ti()

template<class T0, class TO_T>

virtual void D3PD::SingleAssociationTool< Types< T0 >, TO_T >::push_ti ( std::vector< const std::type_info * > & tis )

protectedvirtual

Helper to collect the list of type_info's that we accept.

This first chains to the base class to pick up its list. Then we add the type_info corresponding to the last type in the template argument list.

◆ releaseObject() [1/2]

template<class T0, class TO_T>

virtual void D3PD::SingleAssociationTool< Types< T0 >, TO_T >::releaseObject ( const typename SelectType< TO_T, 0 >::type * )

overridevirtual

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.

Reimplemented from D3PD::SingleAssociationToolTo< TO_T >.

◆ releaseObject() [2/2]

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

virtual

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

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

virtual

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.

◆ releaseObjectUntyped() [2/2]

template<class T0, class TO_T>

virtual void D3PD::SingleAssociationTool< Types< T0 >, TO_T >::releaseObjectUntyped ( const void * p )

overridevirtual

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.

Reimplemented from D3PD::SingleAssociationToolTo< TO_T >.