D3PD::AuxDataFillerTool Class Reference

Copy aux data to D3PD. More...

#include <AuxDataFillerTool.h>

Inheritance diagram for D3PD::AuxDataFillerTool:

Collaboration diagram for D3PD::AuxDataFillerTool:

Classes
struct	Var
	Describe one variable. More...

Public Member Functions
	AuxDataFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	initialize ()
	Standard Gaudi initialize method.
virtual StatusCode	book ()
	Book variables for this block.
virtual StatusCode	fill (const SG::AuxElement &p)
	Fill one block — type-safe version.
	BlockFillerToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check.
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree.
virtual StatusCode	fillUntyped (const void *p, bool again=false)
	Fill one block.
virtual StatusCode	fillAgain (const SG::AuxElement &p)
	Fill one block, after AGAIN has been returned (type-safe).
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.
template<class T>
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Make the template implementation from IAddVariable visible.
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.
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.
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.
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.

Protected Member Functions
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
	Configure during initialization: type-check.
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.
StatusCode	convert (void const *&p) const
	Do type conversion.

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

Private Member Functions
StatusCode	parseVars ()
	Parse the variables property and fill m_vars.

Private Attributes
std::string	m_auxprefix
	Property: Prefix to add to aux data names.
std::vector< std::string >	m_varString
	Property: Specify variables to fill.
std::vector< std::unique_ptr< Var > >	m_vars
	Parsed list of variables.
std::string	m_prefix
	Property: the variable prefix for this block.
std::string	m_suffix
	Property: the variable prefix for this block.
std::string	m_blockName
	Property: the name of this block.
TypeConverter	m_converter
	Helper to do type conversions.
IAddVariable *	m_tree
	Reference to the block name.

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

Detailed Description

Copy aux data to D3PD.

Definition at line 33 of file AuxDataFillerTool.h.

Constructor & Destructor Documentation

AuxDataFillerTool()

D3PD::AuxDataFillerTool::AuxDataFillerTool	(	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 110 of file AuxDataFillerTool.cxx.

  : BlockFillerTool<SG::AuxElement> (type, name, parent)
{
  declareProperty ("AuxPrefix", m_auxprefix,
                   "Prefix to add to aux data names.");
 
  declareProperty ("Vars", m_varString,
                   "Specify variables to fill.  "
                   "Each is of the form VAR[=AUXVAR][<DEF][#DOCSTRING].\n"
                   "VAR is the D3PD variable name.  "
                   "AUXVAR is the aux data item name.  It may contain a class "
                   "name before a ::.  If omitted, it defaults to VAR. "
                   "It may also be a comma-separated string of variable "
                   "names; the first one found to be present will be used. "
                   "If the < is present, then it is not an error for this "
                   "variable to be missing.  If not empty, DEF specifies the "
                   "default value to use (works only for basic types). "
                   "DEF may be preceded with a type name: `TYPE: DEF' to "
                   "specify a type in the case the type of this aux variable "
                   "is unknown. "
                   "An optional documentation string may be given after a #.");
}

Member Function Documentation

addDimensionedVariable() [1/3]

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/3]

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() [3/3]

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/3]

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/3]

template<class T, class U>

StatusCode D3PD::IAddVariable::addVariable ( const std::string & name, T *& ptr, const std::string & docstring, const U & defval )

inherited

Make the template implementation from IAddVariable visible.

addVariable() [3/3]

template<class T>

StatusCode D3PD::IAddVariable::addVariable ( const std::string & name, T *& ptr, const std::string & docstring = "" )

inherited

Make the template implementation from IAddVariable visible.

BlockFillerToolImpl()

( const std::string & type, const std::string & name, const IInterface * parent )

inherited

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

book()

StatusCode D3PD::AuxDataFillerTool::book ( )

virtual

Book variables for this block.

Implements D3PD::BlockFillerTool< SG::AuxElement >.

Definition at line 148 of file AuxDataFillerTool.cxx.

{
  CHECK( parseVars() );
  for (auto& v : m_vars) {
    std::string docstring = "[AuxData: ";
    docstring += v->label;
    docstring += "] ";
    docstring += v->docstring;
    CHECK( addVariable (v->name, *v->ti, v->ptr, docstring, v->defobj.get()) );
  }
  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]

virtual StatusCode D3PD::BlockFillerTool< SG::AuxElement >::configureD3PD ( IAddVariable * tree, const std::type_info & ti )

virtualinherited

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.

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;
}

fill()

StatusCode D3PD::AuxDataFillerTool::fill ( const SG::AuxElement & p )

virtual

Fill one block — type-safe version.

Parameters

p	The input object.

This is called once per object. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

Implements D3PD::BlockFillerTool< SG::AuxElement >.

Definition at line 170 of file AuxDataFillerTool.cxx.

{
  for (auto& v : m_vars) {
    const void* aux = v->access(p);
    if (aux)
      v->type.assign (v->ptr, aux);
    else if (!v->has_default) {
      // Trigger an exception.
      v->accessors[0](p);
    }
  }
 
  return StatusCode::SUCCESS;
}

fillAgain()

virtual StatusCode D3PD::BlockFillerTool< SG::AuxElement >::fillAgain ( const SG::AuxElement & p )

virtualinherited

Fill one block, after AGAIN has been returned (type-safe).

Parameters

p	The input object.

Once fill returns AGAIN, the parent should call fillAgain with the same arguments. This continues until fillAgain returns something other than AGAIN.

By default, this just calls fill().

fillUntyped()

virtual StatusCode D3PD::BlockFillerTool< SG::AuxElement >::fillUntyped ( const void * p, bool again = false )

virtualinherited

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 configureD3PD. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

If the return status is the special code AGAIN (defined above), then this filler tool wants to make multiple entries. The parent should set up to capture a new ‘row’ and run through the list of block filler tools again, but for this tool call fillAgainUntyped instead of fillUntyped. This should be repeated as long as fillAgainUntyped returns AGAIN.

Once fillUntyped returns AGAIN, the parent should call fillUntyped with the same p argument and again set to true. This continues until fillUntyped returns something other than AGAIN.

Not all parents may support this. In that case, returning AGAIN will be treated as an error.

initialize()

StatusCode D3PD::AuxDataFillerTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 139 of file AuxDataFillerTool.cxx.

{
  return BlockFillerTool<SG::AuxElement>::initialize();
}

parseVars()

StatusCode D3PD::AuxDataFillerTool::parseVars ( )

private

Parse the variables property and fill m_vars.

Definition at line 189 of file AuxDataFillerTool.cxx.

{
  for (std::string name : m_varString) {
    std::string docstring;
    std::string::size_type ipos = name.find ('#');
    if (ipos != std::string::npos) {
      docstring = name.substr (ipos+1, std::string::npos);
      name.resize(ipos);
    }
 
    std::string defstring;
    bool has_default = false;
    ipos = name.find ('<');
    if (ipos != std::string::npos) {
      defstring = name.substr (ipos+1, std::string::npos);
      name.erase (ipos, std::string::npos);
      has_default = true;
    }
 
    std::string label = name;
    ipos = name.find ('=');
    if (ipos != std::string::npos) {
      name.erase (ipos, std::string::npos);
      label.erase (0, ipos+1);
    }
 
    std::vector<std::string> labels;
    boost::algorithm::split (labels, label, boost::algorithm::is_any_of(","));
    std::vector<std::string> label_classes;
    for (std::string& l : labels) {
      std::string label_class;
      ipos = l.find ("::");
      if (ipos != std::string::npos) {
        label_class = l.substr (0, ipos);
        l.erase (0, ipos+2);
      }
      boost::algorithm::trim (l);
      l = m_auxprefix + l;
      boost::algorithm::trim (label_class);
      label_classes.push_back (std::move(label_class));
    }
 
    boost::algorithm::trim (name);
    boost::algorithm::trim (docstring);
    boost::algorithm::trim (defstring);
 
    // If a type was given in the default field, make sure this variable
    // name has been registered.
    if (!defstring.empty()) {
      ipos = defstring.find (':');
      if (ipos != std::string::npos) {
        std::string typname = defstring.substr (0, ipos);
        boost::algorithm::trim (typname);
        defstring.erase (0, ipos+1);
        
        RootUtils::Type typ (typname);
        SG::AuxTypeRegistry& reg = SG::AuxTypeRegistry::instance();
        const std::type_info* ti = typ.getTypeInfo();
        if (ti) {
          for (size_t i = 0; i < labels.size(); i++){
            auto auxid = reg.getAuxID (*ti, labels[i], label_classes[i]);
            if (auxid == SG::null_auxid){
              REPORT_MESSAGE(MSG::WARNING)
                <<"AuxDataFillerTool::parseVars: auxid is invalid for "<<labels[i]<<"\n";
            }
          }
        }
      }
    }
 
    try {
      m_vars.push_back (std::make_unique<Var>
                        (name, docstring, labels, label_classes,
                         defstring, has_default));
    }
    catch (const std::runtime_error& e) {
      REPORT_MESSAGE(MSG::ERROR)
        << "Can't find aux data item(s) " << label
        << " [" << e.what() << "]";
      return StatusCode::FAILURE;
    }
 
    if (m_vars.back()->accessors.empty()) {
      REPORT_MESSAGE(MSG::ERROR)
        << "Can't find aux data item(s) " << label;
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_auxprefix

std::string D3PD::AuxDataFillerTool::m_auxprefix

private

Property: Prefix to add to aux data names.

Definition at line 72 of file AuxDataFillerTool.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_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.

m_vars

std::vector<std::unique_ptr<Var> > D3PD::AuxDataFillerTool::m_vars

private

Parsed list of variables.

Definition at line 139 of file AuxDataFillerTool.h.

m_varString

std::vector<std::string> D3PD::AuxDataFillerTool::m_varString

private

Property: Specify variables to fill.

Each is of the form VAR[=AUXVAR][<DEF][#DOCSTRING].

Definition at line 76 of file AuxDataFillerTool.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:

• AuxDataFillerTool.h
• AuxDataFillerTool.cxx