Fill an index of an object within a container. More...

#include <IndexFillerTool.h>

Inheritance diagram for D3PD::IndexFillerTool:

Collaboration diagram for D3PD::IndexFillerTool:

Public Member Functions
	IndexFillerTool (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 Member Functions
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
	Configure during initialization: type-check.
StatusCode	configureImpl (IAddVariable tree, const std::type_info &ti, const std::vector< const std::type_info > &tis, size_t &which)
	Configure during initialization: type-check.
StatusCode	convert (void const *&p) const
	Do type conversion.

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

Private Attributes
std::string	m_targetLabel
	Property: The label of the collection getter defining the collection within which to index.
std::vector< std::string >	m_targetLabels
	Property: The list of labels of collection getters defining the collections within which to index.
std::string	m_containerIndexName
	Variable name to use for the index of the container in which the object was found.
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.
int *	m_containerIndex
	Container index variable.
IndexMap	m_map
	Map from objects to indices.
std::string	m_prefix
	Property: the variable prefix for this block.
std::string	m_suffix
	Property: the variable prefix for this block.
std::string	m_blockName
	Property: the name of this block.
TypeConverter	m_converter
	Helper to do type conversions.
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

Fill an index of an object within a container.

Definition at line 30 of file IndexFillerTool.h.

Constructor & Destructor Documentation

◆ IndexFillerTool()

D3PD::IndexFillerTool::IndexFillerTool	(	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 30 of file IndexFillerTool.cxx.

  : BlockFillerToolImpl (type, name, parent),
    m_index (0),
    m_containerIndex (0),
    m_map (this, m_targetLabel, m_targetLabels, m_registry, m_allowMissing)
{
  declareProperty ("Target",        m_targetLabel,
                   "Label of the collection getter defining the collection "
                   "within which to index.");
  declareProperty ("Targets",       m_targetLabels,
                   "List of labels of collection getters defining the "
                   "collections within which to index. "
                   "If Target is non-empty, it is considered to come "
                   "at the start of this list.");
  declareProperty ("ContainerIndexName", m_containerIndexName,
                   "Variable name to use for the index of the container "
                   "in which the object was found.  Useful if more than "
                   "one target container is specified.  Omitted if this "
                   "is empty.");
  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::IndexFillerTool::book ( )

overridevirtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 102 of file IndexFillerTool.cxx.

{
  if (m_map.target()) {
    std::string indexdoc = "Index in ";
    std::string contdoc = "Container index: ";
    int n = 0;
    if (!m_targetLabel.empty()) {
      indexdoc += m_targetLabel;
      contdoc += "0 - " + m_targetLabel;
      ++n;
    }
    for (size_t i = 0; i < m_targetLabels.size(); i++) {
      if (n > 0) {
        indexdoc += ", ";
        contdoc += ", ";
      }
      indexdoc += m_targetLabels[i];
      std::ostringstream s;
      s << n << " - " << m_targetLabels[i];
      contdoc += s.str();
      ++n;
    }
 
    CHECK( addVariable ("index", m_index, indexdoc, -1) );
 
    if (!m_containerIndexName.empty())
      CHECK( addVariable (m_containerIndexName, m_containerIndex, contdoc, -1));
  }
 
  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::IndexFillerTool::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 80 of file IndexFillerTool.cxx.

{
  CHECK( m_map.configureD3PD (ti) );
  if (m_map.target()) {
    CHECK( configureImpl (tree, ti, m_map.target()->elementTypeinfo()) );
  }
  else {
    REPORT_MESSAGE (MSG::WARNING)
     << "Not booking index variable because no association targets exist: "
     << m_map.formatLabels();
  }
 
  return StatusCode::SUCCESS;
}

◆ configureImpl() [1/2]

StatusCode D3PD::BlockFillerToolImpl::configureImpl	(	IAddVariable *	tree,
		const std::type_info &	ti,
		const std::type_info &	fill_ti )

protectedinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to `fillUntyped`.
fill_ti	is the type of object that the user code will expect.

This is the common implementation for the configureD3PD method of IBlockFillerTool. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.

Definition at line 55 of file BlockFillerToolImpl.cxx.

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

◆ configureImpl() [2/2]

StatusCode D3PD::BlockFillerToolImpl::configureImpl	(	IAddVariable *	tree,
		const std::type_info &	ti,
		const std::vector< const std::type_info * > &	tis,
		size_t &	which )

protectedinherited

Configure during initialization: type-check.

Parameters

	tree	Our parent for tuple making.
	ti	Gives the type of the object being passed to `fillUntyped`.
	tis	List of possible input types that we can accept.
[out]	which	Index of the accepted type.

This is the common implementation for the configureD3PD method of IBlockFillerTool. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.

This version allows for one of a set of types to match. If successful, WHICH is set to the index (0-based) of the matching type.

Definition at line 83 of file BlockFillerToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_converter.init (ti, tis, which) );
  return StatusCode::SUCCESS;
}

◆ convert()

StatusCode D3PD::BlockFillerToolImpl::convert ( void const *& p ) const

protectedinherited

Do type conversion.

Parameters

p[in,out] Pointer to convert.

On entry, p is a pointer to an object of the type that was passed into configureImpl as ti. Convert the pointer to point to an object of the type that was given as fill_ti. If the conversion fails, the pointer is set to 0 (and FAILURE is returned).

Definition at line 105 of file BlockFillerToolImpl.cxx.

{
  p = m_converter.convertUntyped (p);
  if (!p) {
    REPORT_MESSAGE (MSG::ERROR)
      << "Pointer conversion from " << m_converter.srcName() << " to "
      << m_converter.dstName() << "failed.";
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

◆ fillUntyped()

StatusCode D3PD::IndexFillerTool::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 162 of file IndexFillerTool.cxx.

{
  if (m_index) {
    // Build the map if it doesn't exist.
    CHECK( m_map.reset() );
 
    // Search the index container for the pointer.
    std::pair<int, int> out = m_map.findIndexPair (p);
    *m_index = out.first;
    if (m_containerIndex)
      *m_containerIndex = out.second;
  }
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode D3PD::IndexFillerTool::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Definition at line 62 of file IndexFillerTool.cxx.

{
  // Be sure the registry is retrieved, to avoid warnings from Gaudi
  // that the tool is unused.
  ATH_CHECK( m_registry.retrieve() );
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_allowMissing

bool D3PD::IndexFillerTool::m_allowMissing

private

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

Definition at line 119 of file IndexFillerTool.h.

◆ m_blockName

std::string D3PD::BlockFillerToolImpl::m_blockName

privateinherited

Property: the name of this block.

Definition at line 118 of file BlockFillerToolImpl.h.

◆ m_containerIndex

int* D3PD::IndexFillerTool::m_containerIndex

private

Container index variable.

Definition at line 125 of file IndexFillerTool.h.

◆ m_containerIndexName

std::string D3PD::IndexFillerTool::m_containerIndexName

private

Variable name to use for the index of the container in which the object was found.

Useful if more than one target container is specified. Omitted if this is empty.

Definition at line 112 of file IndexFillerTool.h.

◆ m_converter

TypeConverter D3PD::BlockFillerToolImpl::m_converter

privateinherited

Helper to do type conversions.

Definition at line 121 of file BlockFillerToolImpl.h.

◆ m_index

int* D3PD::IndexFillerTool::m_index

private

Index variable.

Definition at line 122 of file IndexFillerTool.h.

◆ m_map

IndexMap D3PD::IndexFillerTool::m_map

private

Map from objects to indices.

Definition at line 128 of file IndexFillerTool.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::BlockFillerToolImpl::m_prefix

privateinherited

Property: the variable prefix for this block.

Definition at line 112 of file BlockFillerToolImpl.h.

◆ m_registry

ToolHandle<ICollectionGetterRegistryTool> D3PD::IndexFillerTool::m_registry

private

Property: The ICollectionGetterRegistryTool instance.

Definition at line 115 of file IndexFillerTool.h.

◆ m_suffix

std::string D3PD::BlockFillerToolImpl::m_suffix

privateinherited

Property: the variable prefix for this block.

Definition at line 115 of file BlockFillerToolImpl.h.

◆ m_targetLabel

std::string D3PD::IndexFillerTool::m_targetLabel

private

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

Definition at line 102 of file IndexFillerTool.h.

◆ m_targetLabels

std::vector<std::string> D3PD::IndexFillerTool::m_targetLabels

private

Property: The list of labels of collection getters defining the collections within which to index.

m_targetLabel is added to the start of this list if it's non-empty.

Definition at line 107 of file IndexFillerTool.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 Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IndexFillerTool()

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]

◆ configureImpl() [1/2]

◆ configureImpl() [2/2]

◆ convert()

◆ fillUntyped()

◆ initialize()

Member Data Documentation

◆ m_allowMissing

◆ m_blockName

◆ m_containerIndex

◆ m_containerIndexName

◆ m_converter

◆ m_index

◆ m_map

◆ m_metadata

◆ m_prefix

◆ m_registry

◆ m_suffix

◆ m_targetLabel

◆ m_targetLabels

◆ m_tree

◆ s_emptyString