VectorFillerTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#include "VectorFillerTool.h"
#include "AthenaKernel/errorcheck.h"
#include "CxxUtils/checker_macros.h"
#include "D3PDMakerInterfaces/ID3PD.h"
#include "GaudiKernel/Incident.h"
#include "GaudiKernel/IIncidentSvc.h"
 
 
namespace D3PD {
 
 
VectorFillerTool::VectorFillerTool (const std::string& type,
                                    const std::string& name,
                                    const IInterface* parent)
  : 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");
}
 
 
StatusCode
VectorFillerTool::initialize()
{
  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;
}
 
 
StatusCode
VectorFillerTool::configureD3PD (IAddVariable* tree)
{
  CHECK( doConfigure (tree, *m_getter) );
 
  // Try to cast the received object into an ID3PD one:
  m_tree = dynamic_cast< ID3PD* >( tree );
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode VectorFillerTool::book()
{
  // 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;
}
 
 
StatusCode
VectorFillerTool::fill()
{
  CHECK( m_getter->reset (m_allowMissing) );
  size_t sz = m_getter->sizeHint (m_allowMissing);
 
  CHECK( doFill (*m_getter, sz) );
 
  return StatusCode::SUCCESS;
}
 
 
bool VectorFillerTool::isContainerFiller() const
{
   return true;
}
 
 
void VectorFillerTool::handle( const Incident& inc )
{
  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;
}
 
 
} // namespace D3PD