Represent a multiple association by containment. More...

#include <ContainedMultiAssociationFillerTool.h>

Inheritance diagram for D3PD::ContainedMultiAssociationFillerTool:

Collaboration diagram for D3PD::ContainedMultiAssociationFillerTool:

Public Member Functions
	ContainedMultiAssociationFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	initialize ()
	Standard Gaudi `initialize` method.
virtual StatusCode	finalize ()
	Standard Gaudi `finalize` method.
virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check.
virtual StatusCode	book ()
	Declare tuple variables.
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree.
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.
template<class T>
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Make the template implementation from `IAddVariable` visible.
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.
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.
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.
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.

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

Private Attributes
const std::string &	m_prefix
	Reference to the variable prefix.
const std::string &	m_suffix
	Reference to the variable suffix.
IAddVariable *	m_tree
	Reference to the block name.

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

Detailed Description

Represent a multiple association by containment.

This is a block filler tool which represents a multiple association by containment. It uses the AGAIN feature of a block filler tool. The effect is that for each source object, there will be multiple entries made, one for each target object. Other variables will generally just be copied.

It takes as a property an IMultiAssociationTool. For each input object, it asks the association tool which objects are associated with it; the result is a collection of 0 or more objects. This tool also has a list of block filler tools; these tools are called for the result of the association.

The tool in addition creates a counter variable to count the of target objects for each source object. If this is -1, then the target object variables are not filled in.

Properties: Associator - The ISingleAssociationTool. BlockFillers - List of contained block filler tools. Prefix - Variable name prefix for the contained blocks. Counter - Variable name to use for the target object counter. Omitted if empty.

Definition at line 56 of file ContainedMultiAssociationFillerTool.h.

Constructor & Destructor Documentation

◆ ContainedMultiAssociationFillerTool()

D3PD::ContainedMultiAssociationFillerTool::ContainedMultiAssociationFillerTool	(	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 ContainedMultiAssociationFillerTool.cxx.

     : base_class (type, name, parent),
       AddVariable (m_prefix, m_blockName),
       m_associator (this),
       m_blockFillers (this),
       m_next (0)
{
  declareProperty ("Associator",   m_associator,
                   "The IMultiAssociationTool instance.");
  declareProperty ("BlockFillers", m_blockFillers,
                   "List of contained block filler tools.");
  declareProperty ("BlockName", m_blockName = this->name(),
                   "The name of this block.");
  declareProperty ("Prefix",       m_prefix = "",
                   "Variable name prefix for the contained blocks.");
}

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

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

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

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

template<class T, class U>

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

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/3]

template<class T>

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

inherited

Make the template implementation from IAddVariable visible.

◆ book()

StatusCode D3PD::ContainedMultiAssociationFillerTool::book ( )

virtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 103 of file ContainedMultiAssociationFillerTool.cxx.

{
  CHECK( m_associator->book () );
  for (size_t i = 0; i < m_blockFillers.size(); i++)
    CHECK( m_blockFillers[i]->book ( ) );
 
  return StatusCode::SUCCESS;
}

◆ configureD3PD() [1/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;
}

◆ configureD3PD() [2/2]

StatusCode D3PD::ContainedMultiAssociationFillerTool::configureD3PD	(	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 `fillUntyped`.

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

Definition at line 85 of file ContainedMultiAssociationFillerTool.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_associator->configureD3PD (this, ti) );
  const std::type_info& ati = m_associator->elementTypeinfo();
  for (size_t i = 0; i < m_blockFillers.size(); i++)
    CHECK( m_blockFillers[i]->configureD3PD (this, ati ) );
 
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode D3PD::ContainedMultiAssociationFillerTool::finalize ( )

virtual

Standard Gaudi finalize method.

Definition at line 65 of file ContainedMultiAssociationFillerTool.cxx.

{
  CHECK( AlgTool::finalize() );
  if (m_next) {
    m_associator->releaseElementUntyped (m_next);
    m_next = 0;
  }
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode D3PD::ContainedMultiAssociationFillerTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 52 of file ContainedMultiAssociationFillerTool.cxx.

{
  CHECK( AthAlgTool::initialize() );
  CHECK( m_associator.retrieve() );
  CHECK( m_blockFillers.retrieve() );
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ 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

const std::string& D3PD::AddVariable::m_prefix

privateinherited

Reference to the variable prefix.

Definition at line 134 of file AddVariable.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:

Public Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ContainedMultiAssociationFillerTool()

Member Function Documentation

◆ addDimensionedVariable() [1/3]

◆ addDimensionedVariable() [2/3]

◆ addDimensionedVariable() [3/3]

◆ addVariable() [1/3]

◆ addVariable() [2/3]

◆ addVariable() [3/3]

◆ book()

◆ configureD3PD() [1/2]

◆ configureD3PD() [2/2]

◆ finalize()

◆ initialize()

Member Data Documentation

◆ m_metadata

◆ m_prefix

◆ m_suffix

◆ m_tree

◆ s_emptyString