AddVariable.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/

 
 
#include "AthenaKernel/errorcheck.h"
#include "D3PDMakerUtils/AddVariable.h"
 
 
namespace D3PD {
 

const std::string AddVariable::s_emptyString;
 

AddVariable::AddVariable (const std::string& prefix,
                          const std::string& /*blockName*/ /*= s_emptyString*/)
  : m_metadata (),
    m_prefix (prefix),
    m_suffix (s_emptyString),
    m_tree (0)
{
}
 

AddVariable::AddVariable (const std::string& prefix,
                          const std::string& /*blockName*/,
                          const std::string& suffix)
  : m_metadata (),
    m_prefix (prefix),
    m_suffix (suffix),
    //m_blockName (blockName),
    m_tree (0)
{
}
 

StatusCode AddVariable::configureD3PD (IAddVariable* tree)
{
  m_tree = tree;
  m_metadata.clear();
  return StatusCode::SUCCESS;
}
 

 * @brief Add a variable to the tuple.
 * @param name The name of the variable.
 * @param type The type of the variable.
 * @param ptr Pointer to the type of the variable.
 *            The pointer need not be initialized;
 *            the D3PD software will set the pointer
 *            prior to calling @c fill().
 * @param docstring Documentation string for this variable.
 * @param 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 @c ti.
 *               Only works for basic types.
 *
 * If called from the constructor, the only effect is to clear @c ptr.
 */
StatusCode AddVariable::addVariable (const std::string& name,
                                     const std::type_info& ti,
                                     void* & ptr,
                                     std::string_view docstring /*= ""*/,
                                     const void* defval /*= 0*/)
{
  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);
}
 

 * If called from the constructor, the only effect is to clear @c ptr.
 */
StatusCode
AddVariable::addDimensionedVariable (const std::string& name,
                                     const std::type_info& ti,
                                     void* & ptr,
                                     const std::string& dim,
                                     std::string_view docstring /*= ""*/,
                                     const void* defval /*= 0*/)
{
  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);
}
 
 
} // namespace D3PD