D3PD::ContainerFlagFillerTool Class Reference

Flag objects that are present in other containers. More...

#include <ContainerFlagFillerTool.h>

Inheritance diagram for D3PD::ContainerFlagFillerTool:

Collaboration diagram for D3PD::ContainerFlagFillerTool:

Public Member Functions
	ContainerFlagFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor. More...
virtual StatusCode	initialize ()
	Function initializing the tool. 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 Member Functions
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
	Configure during initialization: type-check. More...
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. More...
StatusCode	convert (void const *&p) const
	Do type conversion. More...

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

Private Attributes
std::vector< std::string >	m_flagNames
	Property: The flag names. More...
ToolHandleArray< ICollectionGetterTool >	m_getters
	Property: The container getters that are used to compute the flags. More...
bool	m_allowMissing
	Property: If true, missing containers will not be considered errors. More...
std::vector< bool * >	m_flags
	Variables: The flags created in the D3PD. More...
IndexMap	m_map
	Map to manage index lookups. More...
std::string	m_prefix
	Property: the variable prefix for this block. More...
std::string	m_suffix
	Property: the variable prefix for this block. More...
std::string	m_blockName
	Property: the name of this block. More...
TypeConverter	m_converter
	Helper to do type conversions. 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

Flag objects that are present in other containers.

Given a list of variable name / collection getter pairs, this sets each variable to a flag depending on whether or not the input object is found in the corresponding collection getter.

This can be used, for example, with the INav4MomLinkContainer objects created by the DPD making tools, but it should work with any Collection wrapped with a ICollectionGetterToool.

Definition at line 40 of file ContainerFlagFillerTool.h.

Constructor & Destructor Documentation

ContainerFlagFillerTool()

D3PD::ContainerFlagFillerTool::ContainerFlagFillerTool	(	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 21 of file ContainerFlagFillerTool.cxx.

  : BlockFillerToolImpl (type, name, parent),
    m_getters (this),
    m_map (this, m_getters, m_allowMissing)
{
  declareProperty ("FlagNames", m_flagNames,
                   "Names of the flags added to the D3PD."
"May be followed by a string of the form `@TYPE/KEY', in which case the "
"corresponding entry in Getters is automatically initialized (only available "
"when the Python configuration wrapper is used).  May be followed by a "
"docstring following a colon.");
  declareProperty ("Getters", m_getters,
                   "Getter tools for the INav4MomLinkContainer objects.");
  declareProperty ("AllowMissing", m_allowMissing,
                   "If true, missing containers will not be considered errors.");
}

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

virtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 81 of file ContainerFlagFillerTool.cxx.

{
  // Resize the flag vector to the right size:
  m_flags.resize( m_flagNames.size(), 0 );
 
  // Book the flag variable(s):
  for( size_t i = 0; i < m_flagNames.size(); ++i ) {
    std::string flagname = m_flagNames[i];
    std::string desc = "Was this object selected according to X criteria?";
    std::string::size_type ipos = flagname.find (':');
    if (ipos != std::string::npos) {
      desc = flagname.substr (ipos+1, std::string::npos);
      flagname.resize (ipos);
    }
    CHECK( addVariable (flagname, m_flags[ i ], desc) );
  }
 
  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::ContainerFlagFillerTool::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 67 of file ContainerFlagFillerTool.cxx.

{
  CHECK( m_map.configureD3PD (ti) );
  CHECK( AddVariable::configureD3PD (tree) );
  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::ContainerFlagFillerTool::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 configure. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

Definition at line 112 of file ContainerFlagFillerTool.cxx.

{
  if (m_flags.empty())
    return StatusCode(EMPTY);
 
  CHECK( m_map.reset() );
  for (size_t i = 0; i < m_flags.size(); i++)
    *m_flags[i] = (m_map.findIndex (p, i) != -1);
  return StatusCode::SUCCESS;
}

initialize()

StatusCode D3PD::ContainerFlagFillerTool::initialize ( )

virtual

Function initializing the tool.

Standard Gaudi initialize method.

Definition at line 44 of file ContainerFlagFillerTool.cxx.

{
  // Check that the configuration makes sense:
  if( m_getters.size() != m_flagNames.size() ) {
    REPORT_MESSAGE( MSG::FATAL )
      << "Different number of getter tools and flags specified";
    return StatusCode::FAILURE;
  }
 
  CHECK( BlockFillerToolImpl::initialize() );
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_allowMissing

bool D3PD::ContainerFlagFillerTool::m_allowMissing

private

Property: If true, missing containers will not be considered errors.

Definition at line 101 of file ContainerFlagFillerTool.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_converter

TypeConverter D3PD::BlockFillerToolImpl::m_converter

privateinherited

Helper to do type conversions.

Definition at line 121 of file BlockFillerToolImpl.h.

m_flagNames

std::vector<std::string> D3PD::ContainerFlagFillerTool::m_flagNames

private

Property: The flag names.

Definition at line 95 of file ContainerFlagFillerTool.h.

m_flags

std::vector<bool*> D3PD::ContainerFlagFillerTool::m_flags

private

Variables: The flags created in the D3PD.

Definition at line 104 of file ContainerFlagFillerTool.h.

m_getters

ToolHandleArray<ICollectionGetterTool> D3PD::ContainerFlagFillerTool::m_getters

private

Property: The container getters that are used to compute the flags.

Definition at line 98 of file ContainerFlagFillerTool.h.

m_map

IndexMap D3PD::ContainerFlagFillerTool::m_map

private

Map to manage index lookups.

Definition at line 107 of file ContainerFlagFillerTool.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_suffix

std::string D3PD::BlockFillerToolImpl::m_suffix

privateinherited

Property: the variable prefix for this block.

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

• ContainerFlagFillerTool.h
• ContainerFlagFillerTool.cxx