Represent a single association by containment. More...

#include <ContainedAssociationFillerTool.h>

Inheritance diagram for D3PD::ContainedAssociationFillerTool:

Collaboration diagram for D3PD::ContainedAssociationFillerTool:

Public Member Functions
	ContainedAssociationFillerTool (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 StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check. More...

virtual StatusCode	book ()
	Declare tuple variables. More...

virtual StatusCode	fillUntyped (const void *p, bool again=false)
	Fill one block. 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 Attributes
ObjectMetadata	m_metadata
	Metadata about the variables created by this object. More...

Private Attributes
ToolHandle< ISingleAssociationTool >	m_associator
	Property: The association tool instance. More...

ToolHandleArray< IBlockFillerTool >	m_blockFillers
	Property: The list of block filler tools. More...

std::string	m_prefix
	Property: The variable name prefix. More...

std::string	m_suffix
	Property: The variable name suffix. More...

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

std::string	m_matchedName
	Property: The variable name to use for the matched flag. More...

bool *	m_matched
	Variable to flag that the association succeeded. 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

Represent a single association by containment.

This is a block filler tool which represents a single association by containment.

It takes as a property an ISingleAssociationTool. For each input object, it asks the association tool which object is associated with it. 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 flag variable to record whether the association succeeded. If the association fails, the flag is set to false, and the contained variables are left blank.

Properties: Associator - The ISingleAssociationTool. BlockFillers - List of contained block filler tools. Prefix - Variable name prefix for the contained blocks. Matched - Variable name to use for the matched flag. Omitted if empty.

Definition at line 52 of file ContainedAssociationFillerTool.h.

Constructor & Destructor Documentation

◆ ContainedAssociationFillerTool()

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

      : base_class (type, name, parent),
        AddVariable (m_prefix, m_blockName, m_suffix),
        m_associator (this),
        m_blockFillers (this),
        m_matched (0)
 {
   declareProperty ("Associator",   m_associator,
                    "The ISingleAssociationTool instance.");
   declareProperty ("BlockFillers", m_blockFillers,
                    "List of contained block filler tools.");
   declareProperty ("Prefix",       m_prefix = "",
                    "Variable name prefix for the contained blocks.");
   declareProperty ("Suffix",       m_suffix = "",
                    "Variable name suffix for the contained blocks.");
   declareProperty ("BlockName", m_blockName = this->name(),
                    "The name of this block.");
   declareProperty ("Matched",      m_matchedName = "matched",
                    "Variable name to use for the matched flag.  "
                    "Omitted if empty.");
 }

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::ContainedAssociationFillerTool::book ( )

virtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 93 of file ContainedAssociationFillerTool.cxx.

 {
   CHECK( m_associator->book () );
   for (size_t i = 0; i < m_blockFillers.size(); i++)
     CHECK( m_blockFillers[i]->book ( ) );
  
   if (!m_matchedName.empty())
     CHECK( addVariable (m_matchedName, m_matched) );
  
   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::ContainedAssociationFillerTool::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 75 of file ContainedAssociationFillerTool.cxx.

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

◆ fillUntyped()

StatusCode D3PD::ContainedAssociationFillerTool::fillUntyped	(	const void *	p,
		bool	again = `false`
	)

virtual

Fill one block.

Parameters

p	The input object.
again	Set if this is a subsequent call requested by an AGAIN return

This is called once per object. The type of the object at which p points is given by the ti argument to configureD3PD. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

If the return status is the special code AGAIN (defined above), then this filler tool wants to make multiple entries. The parent should set up to capture a new ‘row’ and run through the list of block filler tools again, but for this tool call fillAgainUntyped instead of fillUntyped. This should be repeated as long as fillAgainUntyped returns AGAIN.

Once fillUntyped returns AGAIN, the parent should call fillUntyped with the same p argument and again set to true. This continues until fillUntyped returns something other than AGAIN.

Not all parents may support this. In that case, returning AGAIN will be treated as an error.

The return code may also be EMPTY if this tool did not fill in anything. If all tools return empty, the parent may omit the row.

Definition at line 136 of file ContainedAssociationFillerTool.cxx.

 {
   const void* pout = m_associator->getUntyped (p);
   StatusCode scout (EMPTY);
   if (pout) {
     if (!m_matchedName.empty())
       *m_matched = true;
     for (size_t i = 0; i < m_blockFillers.size(); i++) {
       // Set checked flag on scout.
       // Otherwise, if we get an exception in the child, all we'll see
       // is an unchecked status code error with no mention of the
       // actual exception...
       scout.ignore();
       CHECK( againok (m_blockFillers[i]->fillUntyped (pout, again), scout) );
     }
   }
   m_associator->releaseObjectUntyped (pout);
  
   scout = StatusCode(scout.getCode()); // Make sure checked flag is clear again.
   return againok (scout);
 }

◆ initialize()

StatusCode D3PD::ContainedAssociationFillerTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 57 of file ContainedAssociationFillerTool.cxx.

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

Member Data Documentation

◆ m_associator

ToolHandle<ISingleAssociationTool> D3PD::ContainedAssociationFillerTool::m_associator

private

Property: The association tool instance.

Definition at line 127 of file ContainedAssociationFillerTool.h.

◆ m_blockFillers

ToolHandleArray<IBlockFillerTool> D3PD::ContainedAssociationFillerTool::m_blockFillers

private

Property: The list of block filler tools.

Definition at line 130 of file ContainedAssociationFillerTool.h.

◆ m_blockName

std::string D3PD::ContainedAssociationFillerTool::m_blockName

private

Property: the name of this block.

Definition at line 139 of file ContainedAssociationFillerTool.h.

◆ m_matched

bool* D3PD::ContainedAssociationFillerTool::m_matched

private

Variable to flag that the association succeeded.

Definition at line 146 of file ContainedAssociationFillerTool.h.

◆ m_matchedName

std::string D3PD::ContainedAssociationFillerTool::m_matchedName

private

Property: The variable name to use for the matched flag.

Omitted if empty.

Definition at line 143 of file ContainedAssociationFillerTool.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::ContainedAssociationFillerTool::m_prefix

private

Property: The variable name prefix.

Definition at line 133 of file ContainedAssociationFillerTool.h.

◆ m_suffix

std::string D3PD::ContainedAssociationFillerTool::m_suffix

private

Property: The variable name suffix.

Definition at line 136 of file ContainedAssociationFillerTool.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

◆ ContainedAssociationFillerTool()

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]

◆ fillUntyped()

◆ initialize()

Member Data Documentation

◆ m_associator

◆ m_blockFillers

◆ m_blockName

◆ m_matched

◆ m_matchedName

◆ m_metadata

◆ m_prefix

◆ m_suffix

◆ m_tree

◆ s_emptyString