Object filler tool for a single object. More...

#include <ObjFillerTool.h>

Inheritance diagram for D3PD::ObjFillerTool:

Collaboration diagram for D3PD::ObjFillerTool:

Public Member Functions
	ObjFillerTool (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)
	Configure the tool. More...

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

virtual StatusCode	fill ()
	Fill one object. More...

virtual bool	isContainerFiller () const
	Find out if the filler handles containers or single objects. More...

virtual void	handle (const Incident &inc)
	Handle end of run incidents to save the metadata at that point. 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< IObjGetterTool >	m_getter
	Property: The object getter tool. More...

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

std::string	m_prefix
	Property: Variable prefix for this block. More...

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

std::string	m_objectName
	Property: the name of the D3PDObject that created this tool. More...

bool	m_allowMissing
	Property: If true, the input object is allowed to be missing. More...

bool	m_saveMetadata
	Property: If true, the metadata about the variables is saved. More...

ID3PD *	m_tree
	Pointer to the ID3PD object used. More...

const std::string &	m_suffix
	Reference to the variable suffix. More...

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

Detailed Description

Object filler tool for a single object.

This is an object filler tool for a single object. It has the following properties:

Getter - IObjGetterTool instance. BlockFillers - List of IBlockFillerTool instances. Prefix - Prefix to add to variable names for this block.

For each event, we call the getter to retrieve the object. Then we loop over all block filler tools, passing the object to each.

Definition at line 49 of file ObjFillerTool.h.

Constructor & Destructor Documentation

◆ ObjFillerTool()

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

   : base_class (type, name, parent),
     AddVariable (m_prefix, m_blockName),
     m_getter (this),
     m_blockFillers (this),
     m_tree (0)
 {
   declareProperty ("Getter",       m_getter,
                    "The IObjGetterTool instance.");
   declareProperty ("BlockFillers", m_blockFillers,
                    "List of contained block filler tools.");
   declareProperty ("Prefix",       m_prefix = "",
                    "Variable name prefix for the contained blocks.");
   declareProperty ("BlockName", m_blockName = this->name(),
                    "The name of this block.");
   declareProperty ("ObjectName", m_objectName = "",
                    "Name of the D3PDObject that created this filler.");
   declareProperty ("AllowMissing", m_allowMissing = false,
                    "If true, then it is not considered an error for the "
                    "requested input object to be missing.");
   declareProperty ("SaveMetadata", m_saveMetadata = false,
                    "Set to true to get metadata into the output D3PD "
                    "about the variables created by this tool");
 }

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

virtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 105 of file ObjFillerTool.cxx.

 {
   // Be sure aux variables are defined.
   (void)m_getter->getUntyped (m_allowMissing);
  
   // Configure the metadata object correctly:
   m_metadata.setPrefix( m_prefix );
   m_metadata.setName( m_objectName );
   m_metadata.setContainer( isContainerFiller() );
  
   for (size_t i = 0; i < m_blockFillers.size(); i++)
     CHECK( m_blockFillers[i]->book() );
   
   return StatusCode::SUCCESS;
 }

◆ configureD3PD()

StatusCode D3PD::ObjFillerTool::configureD3PD ( IAddVariable * tree )

virtual

Configure the tool.

Parameters

tree	The parent D3PD tree.

This is called during initialization.

Definition at line 84 of file ObjFillerTool.cxx.

 {
   // The type that the getter will provide.
   const std::type_info& ti = m_getter->typeinfo();
  
   CHECK( AddVariable::configureD3PD (tree) );
   for (size_t i = 0; i < m_blockFillers.size(); i++)
     CHECK( m_blockFillers[i]->configureD3PD (this, ti) );
  
   // Try to cast the received object into an ID3PD one:
   m_tree = dynamic_cast< ID3PD* >( tree );
  
   return StatusCode::SUCCESS;
 }

◆ fill()

StatusCode D3PD::ObjFillerTool::fill ( )

virtual

Fill one object.

This is called once per event. It should:

Fetch the input.
If it's a container, loop over the contents.
Loop over the contained block filler tools.

Definition at line 131 of file ObjFillerTool.cxx.

 {
   const void* obj = m_getter->getUntyped (m_allowMissing);
   if (!obj) {
     if (m_allowMissing)
       return StatusCode::SUCCESS;
     REPORT_MESSAGE(MSG::ERROR) << "Can't get input object.";
     return StatusCode::FAILURE;
   }
  
   for (size_t i = 0; i < m_blockFillers.size(); i++)
     CHECK( m_blockFillers[i]->fillUntyped (obj) );
  
   m_getter->releaseObjectUntyped (obj);
  
   return StatusCode::SUCCESS;
 }

◆ handle()

void D3PD::ObjFillerTool::handle ( const Incident & inc )

virtual

Handle end of run incidents to save the metadata at that point.

The metadata saving is now done when seeing an end of run incident.

This is needed because of MC11b...

Basically, we can't do this in finalize(), because the output TTree is no longer accessible by then. So it has to be done just before the event loop is finished.

Definition at line 170 of file ObjFillerTool.cxx.

 {
   if( inc.type() == "EndEvtLoop" ) {
     if( m_tree && m_metadata.variables().size() && m_saveMetadata ) {
       const std::string metadata = m_metadata.toString();
       // safe because this incident handler is only called serially
       const std::string metadataName ATLAS_THREAD_SAFE = m_metadata.metadataName();
       if( m_tree->addMetadata( metadataName,
                                &metadata ).isFailure() ) {
         REPORT_MESSAGE( MSG::ERROR )
            << "Couldn't add object metadata information to the output!";
         return;
       }
     }
   }
  
   return;
 }

◆ initialize()

StatusCode D3PD::ObjFillerTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 62 of file ObjFillerTool.cxx.

 {
   CHECK( AthAlgTool::initialize() );
   CHECK( m_getter.retrieve() );
   CHECK( m_blockFillers.retrieve() );
  
   // Listen to EndEvent and EndRun incidents:
   ServiceHandle< IIncidentSvc > p_incSvc( "IncidentSvc", name() );
   CHECK( p_incSvc.retrieve() );
   p_incSvc->addListener( this, "EndEvtLoop" );
  
   return StatusCode::SUCCESS;
 }

◆ isContainerFiller()

bool D3PD::ObjFillerTool::isContainerFiller ( ) const

virtual

Find out if the filler handles containers or single objects.

This is used by the D3PDReader code generator to know how to create the generated source files exactly.

Definition at line 156 of file ObjFillerTool.cxx.

 {
    return false;
 }

Member Data Documentation

◆ m_allowMissing

bool D3PD::ObjFillerTool::m_allowMissing

private

Property: If true, the input object is allowed to be missing.

Definition at line 129 of file ObjFillerTool.h.

◆ m_blockFillers

ToolHandleArray<IBlockFillerTool> D3PD::ObjFillerTool::m_blockFillers

private

Property: The list of block filler tools.

Definition at line 117 of file ObjFillerTool.h.

◆ m_blockName

std::string D3PD::ObjFillerTool::m_blockName

private

Property: the name of this block.

Definition at line 123 of file ObjFillerTool.h.

◆ m_getter

ToolHandle<IObjGetterTool> D3PD::ObjFillerTool::m_getter

private

Property: The object getter tool.

Definition at line 114 of file ObjFillerTool.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_objectName

std::string D3PD::ObjFillerTool::m_objectName

private

Property: the name of the D3PDObject that created this tool.

Definition at line 126 of file ObjFillerTool.h.

◆ m_prefix

std::string D3PD::ObjFillerTool::m_prefix

private

Property: Variable prefix for this block.

Definition at line 120 of file ObjFillerTool.h.

◆ m_saveMetadata

bool D3PD::ObjFillerTool::m_saveMetadata

private

Property: If true, the metadata about the variables is saved.

Definition at line 132 of file ObjFillerTool.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

ID3PD* D3PD::ObjFillerTool::m_tree

private

Pointer to the ID3PD object used.

Definition at line 135 of file ObjFillerTool.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

◆ ObjFillerTool()

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()

◆ fill()

◆ handle()

◆ initialize()

◆ isContainerFiller()

Member Data Documentation

◆ m_allowMissing

◆ m_blockFillers

◆ m_blockName

◆ m_getter

◆ m_metadata

◆ m_objectName

◆ m_prefix

◆ m_saveMetadata

◆ m_suffix

◆ m_tree

◆ s_emptyString