Represent a single association by index. More...

#include <IndexAssociationFillerTool.h>

Inheritance diagram for D3PD::IndexAssociationFillerTool:

Collaboration diagram for D3PD::IndexAssociationFillerTool:

Public Member Functions
	IndexAssociationFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	initialize () override
	Standard Gaudi `initialize` method.
virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti) override
	Configure during initialization: type-check.
virtual StatusCode	book () override
	Declare tuple variables.
virtual StatusCode	fillUntyped (const void *p, bool again=false) override
	Fill one block.
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
ToolHandle< ISingleAssociationTool >	m_associator
	Property: The association tool instance.
std::string	m_targetLabel
	Property: The label of the collection getter defining the collection within which to index.
std::string	m_prefix
	Property: The variable name prefix.
std::string	m_blockName
	Property: the name of this block.
ToolHandle< ICollectionGetterRegistryTool >	m_registry
	Property: The ICollectionGetterRegistryTool instance.
bool	m_allowMissing
	Property: Don't give an error if the target getter fails to find the input objects.
int *	m_index
	Index variable.
TypeConverter	m_converter
	Helper to convert from pointer returned by the associator to pointer into the index container.
IndexMap	m_map
	Map from objects to indices.
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 single association by index.

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

It takes as a property an ISingleAssociationTool. For each input object, it asks the association tool which object is associated with it. It also takes as a property a collection getter label. This defines an ‘index’ collection. The tool searches this collection for the target of the association and finds the index of that object within that collection. That index is then booked as a variable.

The index is set to -1 if the association fails or if the object isn't found in the index container.

Properties: Associator - The ISingleAssociationTool instance. Target - Label of the collection getter defining the collection within which to index. Prefix - Variable name prefix for the contained blocks. CollectionGetterRegistry - The ICollectionGetterRegistryTool instance.

Definition at line 61 of file IndexAssociationFillerTool.h.

Constructor & Destructor Documentation

◆ IndexAssociationFillerTool()

D3PD::IndexAssociationFillerTool::IndexAssociationFillerTool	(	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 28 of file IndexAssociationFillerTool.cxx.

     : base_class (type, name, parent),
       AddVariable (m_prefix, m_blockName),
       m_associator (this),
       m_index (0),
       m_map (this, m_targetLabel, m_registry, m_allowMissing)
{
  declareProperty ("Associator",    m_associator,
                   "The ISingleAssociationTool instance.");
  declareProperty ("Target",        m_targetLabel,
                   "Label of the collection getter defining the collection "
                   "within which to index.");
  declareProperty ("Prefix",        m_prefix,
                   "Variable name prefix for the index variable.");
  declareProperty ("BlockName", m_blockName = this->name(),
                   "The name of this block.");
  declareProperty ("CollectionGetterRegistry", m_registry,
                   "The ICollectionGetterRegistryTool instance.");
  declareProperty ("AllowMissing", m_allowMissing = false,
                   "If true, then it is not considered an error for the "
                   "target getter to fail to find the input objects.");
}

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

overridevirtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 111 of file IndexAssociationFillerTool.cxx.

{
  CHECK( m_associator->book () );
  if (m_map.target())
    CHECK( addVariable ("index", m_index) );
  else
    m_index = 0;
 
  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::IndexAssociationFillerTool::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.

Definition at line 85 of file IndexAssociationFillerTool.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_associator->configureD3PD (this, ti) );
  CHECK( m_map.configureD3PD() );
 
  if (m_map.target()) {
    CHECK( m_converter.init (m_associator->typeinfo(),
                             m_map.target()->elementTypeinfo()) );
  }
  else {
    REPORT_MESSAGE_WITH_CONTEXT (MSG::WARNING,
                                 "D3PD::IndexAssociationFillerTool")
     << "Not booking index variable because association target does not exist.";
  }
 
  return StatusCode::SUCCESS;
}

◆ fillUntyped()

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

overridevirtual

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.

Definition at line 150 of file IndexAssociationFillerTool.cxx.

{
  // Build the map if it doesn't exist.
  CHECK( m_map.reset() );
 
  // Default index value.
  if (m_index)
    *m_index = -1;
 
  // Do the association.
  const void* pout = m_associator->getUntyped (p);
  if (pout) {
 
    if (m_index) {
      // Convert to the proper pointer type to search in the container.
      const void* pnew = m_converter.convertUntyped (pout);
      if (!pnew) {
        REPORT_MESSAGE (MSG::WARNING)
          << "Pointer conversion from " << m_converter.srcName() << " to "
          << m_converter.dstName() << "failed.";
      }
      else {
        // Search the index container for the pointer.
        *m_index = m_map.findIndex (pnew);
      }
    }
 
    m_associator->releaseObjectUntyped (pout);
  }
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode D3PD::IndexAssociationFillerTool::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Definition at line 59 of file IndexAssociationFillerTool.cxx.

{
  REPORT_MESSAGE(MSG::WARNING)
    << "IndexAssociationFillerTool is deprecated; use instead "
    << "ContainedAssociationFillerTool with IndexFillerTool. "
    << "IndexAssociation.py should do that for you.";
 
  CHECK( AthAlgTool::initialize() );
  CHECK( m_associator.retrieve() );
 
  // Be sure the registry is retrieved, to avoid warnings from Gaudi
  // that the tool is unused.
  CHECK( m_registry.retrieve() );
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_allowMissing

bool D3PD::IndexAssociationFillerTool::m_allowMissing

private

Property: Don't give an error if the target getter fails to find the input objects.

Definition at line 149 of file IndexAssociationFillerTool.h.

◆ m_associator

ToolHandle<ISingleAssociationTool> D3PD::IndexAssociationFillerTool::m_associator

private

Property: The association tool instance.

Definition at line 132 of file IndexAssociationFillerTool.h.

◆ m_blockName

std::string D3PD::IndexAssociationFillerTool::m_blockName

private

Property: the name of this block.

Definition at line 142 of file IndexAssociationFillerTool.h.

◆ m_converter

TypeConverter D3PD::IndexAssociationFillerTool::m_converter

private

Helper to convert from pointer returned by the associator to pointer into the index container.

Definition at line 156 of file IndexAssociationFillerTool.h.

◆ m_index

int* D3PD::IndexAssociationFillerTool::m_index

private

Index variable.

Definition at line 152 of file IndexAssociationFillerTool.h.

◆ m_map

IndexMap D3PD::IndexAssociationFillerTool::m_map

private

Map from objects to indices.

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

private

Property: The variable name prefix.

Definition at line 139 of file IndexAssociationFillerTool.h.

◆ m_registry

ToolHandle<ICollectionGetterRegistryTool> D3PD::IndexAssociationFillerTool::m_registry

private

Property: The ICollectionGetterRegistryTool instance.

Definition at line 145 of file IndexAssociationFillerTool.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_targetLabel

std::string D3PD::IndexAssociationFillerTool::m_targetLabel

private

Property: The label of the collection getter defining the collection within which to index.

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

◆ IndexAssociationFillerTool()

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]

◆ fillUntyped()

◆ initialize()

Member Data Documentation

◆ m_allowMissing

◆ m_associator

◆ m_blockName

◆ m_converter

◆ m_index

◆ m_map

◆ m_metadata

◆ m_prefix

◆ m_registry

◆ m_suffix

◆ m_targetLabel

◆ m_tree

◆ s_emptyString