Object filler tool for a collection of objects, saved as vectors. More...

#include <VectorFillerTool.h>

Inheritance diagram for D3PD::VectorFillerTool:

Collaboration diagram for D3PD::VectorFillerTool:

Public Member Functions
	VectorFillerTool (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...

Private Attributes
ToolHandle< ICollectionGetterTool >	m_getter
	Property: The collection getter tool. 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...

Detailed Description

Object filler tool for a collection of objects, saved as vectors.

This is an object filler tool for a collection of objects. The object variables are saved as vectors. I.e., if a block books a variable of type ‘int’, the variable we actually create is of type ‘vector<int>’. An additional variable giving the object count is added automatically (can be controlled via the NrowName property).

This tool has the following properties:

Getter - ICollectionGetterTool instance. AllowMissing - If true, then it is not considered an error for the requested input object to be missing.

and the following inherited from VectorFillerToolBase:

BlockFillers - List of IBlockFillerTool instances. Prefix - Prefix to add to variable names for this block. NrowName - Name of the variable for the count of rows. Omitted if empty. Default: ‘n’. NobjName - Name of the variable for the count of objects. (May be less than the number of rows if AGAIN is used.) Omitted if empty (default). ObjIndexName - Name of the variable for the object index. Omitted if empty (default).

For each event, we call the getter to retrieve the collection. We then loop over the objects in the collection. For each object, we set the variable pointers to point to the proper locations within the vectors. Then we loop over all block filler tools, passing the object to each.

Definition at line 68 of file VectorFillerTool.h.

Constructor & Destructor Documentation

◆ VectorFillerTool()

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

   : base_class (type, name, parent),
     m_getter (this),
     m_tree (0)
 {
   declareProperty ("Getter",       m_getter,
                    "The ICollectionGetterTool instance.");
   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

◆ book()

StatusCode D3PD::VectorFillerTool::book ( )

virtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 94 of file VectorFillerTool.cxx.

 {
   // Be sure aux variables are defined.
   CHECK( m_getter->reset (m_allowMissing) );
  
   // Configure the metadata object correctly:
   m_metadata.setName( m_objectName );
   m_metadata.setPrefix( m_prefix );
   m_metadata.setContainer( isContainerFiller() );
  
   CHECK( doBook() );
  
   return StatusCode::SUCCESS;
 }

◆ configureD3PD()

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

virtual

Configure the tool.

Parameters

tree	The parent D3PD tree.

This is called during initialization.

Definition at line 78 of file VectorFillerTool.cxx.

 {
   CHECK( doConfigure (tree, *m_getter) );
  
   // Try to cast the received object into an ID3PD one:
   m_tree = dynamic_cast< ID3PD* >( tree );
  
   return StatusCode::SUCCESS;
 }

◆ fill()

StatusCode D3PD::VectorFillerTool::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 119 of file VectorFillerTool.cxx.

 {
   CHECK( m_getter->reset (m_allowMissing) );
   size_t sz = m_getter->sizeHint (m_allowMissing);
  
   CHECK( doFill (*m_getter, sz) );
  
   return StatusCode::SUCCESS;
 }

◆ handle()

void D3PD::VectorFillerTool::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 150 of file VectorFillerTool.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::VectorFillerTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 54 of file VectorFillerTool.cxx.

 {
   CHECK( VectorFillerToolBase::initialize() );
  
   // Make sure the block fillers are initialized before the getter,
   // so that it's more likely for the DataVector info to be available.
   CHECK( m_getter.retrieve() );
  
   // Listen to the EndEvtLoop incident:
   ServiceHandle< IIncidentSvc > p_incSvc( "IncidentSvc", name() );
   CHECK( p_incSvc.retrieve() );
   p_incSvc->addListener( this, "EndEvtLoop" );
  
   return StatusCode::SUCCESS;
 }

◆ isContainerFiller()

bool D3PD::VectorFillerTool::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 136 of file VectorFillerTool.cxx.

 {
    return true;
 }

Member Data Documentation

◆ m_allowMissing

bool D3PD::VectorFillerTool::m_allowMissing

private

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

Definition at line 141 of file VectorFillerTool.h.

◆ m_getter

ToolHandle<ICollectionGetterTool> D3PD::VectorFillerTool::m_getter

private

Property: The collection getter tool.

Definition at line 135 of file VectorFillerTool.h.

◆ m_objectName

std::string D3PD::VectorFillerTool::m_objectName

private

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

Definition at line 138 of file VectorFillerTool.h.

◆ m_saveMetadata

bool D3PD::VectorFillerTool::m_saveMetadata

private

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

Definition at line 144 of file VectorFillerTool.h.

◆ m_tree

ID3PD* D3PD::VectorFillerTool::m_tree

private

Pointer to the ID3PD object used.

Definition at line 147 of file VectorFillerTool.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VectorFillerTool()

Member Function Documentation

◆ book()

◆ configureD3PD()

◆ fill()

◆ handle()

◆ initialize()

◆ isContainerFiller()

Member Data Documentation

◆ m_allowMissing

◆ m_getter

◆ m_objectName

◆ m_saveMetadata

◆ m_tree