asg::AsgToolConfig Class Reference

an object that can create a AsgTool More...

#include <AsgToolConfig.h>

Inheritance diagram for asg::AsgToolConfig:

Collaboration diagram for asg::AsgToolConfig:

Public Member Functions
	AsgToolConfig ()=default
	standard constructor More...
	AsgToolConfig (const std::string &val_typeAndName)
	initializing constructor More...
	AsgToolConfig (const AsgComponentConfig &val_config)
	initializing constructor More...
template<typename T >
::StatusCode	makeTool (ToolHandle< T > &toolHandle, std::shared_ptr< void > &cleanup, bool allowNestedName=false) const
	make a tool with the given configuration More...
template<typename T >
::StatusCode	makePrivateTool (ToolHandle< T > &toolHandle) const
	make a private tool with the given configuration More...
template<typename T >
::StatusCode	makeTool (ToolHandle< T > &toolHandle, std::shared_ptr< void > &, bool allowNestedName) const
template<typename T >
::StatusCode	makePrivateTool (ToolHandle< T > &toolHandle) const
bool	empty () const noexcept
	whether all properties are unset More...
const std::string &	type () const noexcept
	the type of the component More...
void	setType (const std::string &val_type)
	set the value of type More...
const std::string &	name () const noexcept
	the name of the component More...
void	setName (const std::string &val_name)
	set the value of name More...
std::string	typeAndName () const
	get type and name at the same time More...
void	setTypeAndName (const std::string &val_typeAndName)
	set type and name at the same time More...
template<typename T >
StatusCode	setProperty (const std::string &name, const T &value)
	set the given property More...
void	setPropertyFromString (const std::string &name, const std::string &value)
	set a given property from a string value More...
StatusCode	createPrivateTool (const std::string &name, const std::string &toolType)
	create a private tool of the given name and type More...
StatusCode	addPrivateTool (const std::string &name, AsgComponentConfig toolConfig)
	add a private tool from the given configuration More...
std::string	createPrivateToolInArray (const std::string &name, const std::string &toolType)
	the array version of createPrivateTool More...
std::string	addPrivateToolInArray (const std::string &name, AsgComponentConfig toolConfig)
	the array version of addPrivateTool More...
StatusCode	configureComponentExpert (const std::string &prefix, bool nestedNames) const
	add component configuration to configuration service (expert only) More...

Private Member Functions
StatusCode	checkTypeName (bool nestedNames) const
	check that the type and name members have the correct format More...

Private Attributes
std::string	m_type
	the value of type More...
std::string	m_name
	the value of name More...
std::map< std::string, details::AsgComponentPrivateToolConfig >	m_privateTools
	the map of (private) tools to create More...
std::map< std::string, std::vector< std::string > >	m_toolArrays
	the map of (private) tool handle arrays to manage, and the tools they contain More...
std::map< std::string, std::string >	m_propertyValues
	the map of property values More...

Detailed Description

an object that can create a AsgTool

Definition at line 21 of file AsgToolConfig.h.

Constructor & Destructor Documentation

AsgToolConfig() [1/3]

asg::AsgToolConfig::AsgToolConfig ( )

default

standard constructor

Guarantee

strong

Failures

out of memory I

AsgToolConfig() [2/3]

asg::AsgToolConfig::AsgToolConfig ( const std::string &  val_typeAndName )

explicit

initializing constructor

Guarantee

strong

Failures

out of memory II

Definition at line 24 of file AsgToolConfig.cxx.

    : AsgComponentConfig (val_typeAndName)
  {}

AsgToolConfig() [3/3]

asg::AsgToolConfig::AsgToolConfig ( const AsgComponentConfig &  val_config )

explicit

initializing constructor

Guarantee

strong

Failures

out of memory II

Definition at line 31 of file AsgToolConfig.cxx.

    : AsgComponentConfig (val_config)
  {}

Member Function Documentation

accessSubtool()

AsgComponentConfig::AccessSubtoolData asg::AsgComponentConfig::accessSubtool ( const std::string &  name, std::size_t  split  )

privateinherited

Definition at line 239 of file AsgComponentConfig.cxx.

  {
    AccessSubtoolData result;
    auto subtool = m_privateTools.find (name.substr (0, split));
    if (subtool == m_privateTools.end())
      throw std::runtime_error ("trying to access unknown private tool: " + name.substr (0, split));
    result.config = &(subtool->second.m_config);
    result.prefix = name.substr (0, split + 1);
    result.name = name.substr (split + 1);
    return result;
  }

addPrivateTool()

StatusCode asg::AsgComponentConfig::addPrivateTool ( const std::string &  name, AsgComponentConfig  toolConfig  )

inherited

add a private tool from the given configuration

This will ignore the name set in toolConfig and use whatever name is given instead.

Guarantee

basic

Failures

out of memory II

Definition at line 167 of file AsgComponentConfig.cxx.

  {
    using namespace msgComponentConfig;
 
    auto split = name.find ('.');
    if (split == std::string::npos)
    {
      toolConfig.setName (name);
      m_privateTools[name] = {toolConfig, ""};
      return StatusCode::SUCCESS;
    } else
    {
      auto subtool = accessSubtool (name, split);
      return subtool.config->addPrivateTool (subtool.name, std::move (toolConfig));
    }
  }

addPrivateToolInArray()

std::string asg::AsgComponentConfig::addPrivateToolInArray ( const std::string &  name, AsgComponentConfig  toolConfig  )

inherited

the array version of addPrivateTool

This will ignore the name set in toolConfig and use whatever name is given instead.

Guarantee

basic

Failures

out of memory II

Definition at line 188 of file AsgComponentConfig.cxx.

  {
    using namespace msgComponentConfig;
 
    auto split = name.find ('.');
    if (split == std::string::npos)
    {
      auto& arrayData = m_toolArrays[name];
      auto myname = makeArrayName (name, arrayData.size());
      toolConfig.setName (myname);
      m_privateTools[myname] = {toolConfig, name};
      arrayData.push_back (myname);
      return myname;
    } else
    {
      auto subtool = accessSubtool (name, split);
      return subtool.prefix + subtool.config
        ->addPrivateToolInArray (subtool.name, std::move (toolConfig));
    }
  }

checkTypeName()

StatusCode asg::AsgComponentConfig::checkTypeName ( bool  nestedNames ) const

privateinherited

check that the type and name members have the correct format

Guarantee

strong

Failures

type or name doesn't have proper format

Definition at line 213 of file AsgComponentConfig.cxx.

  {
    using namespace msgComponentConfig;
 
    std::regex typeExpr ("[A-Za-z_][A-Za-z0-9_]*(::[A-Za-z_][A-Za-z0-9_]*)*");
    if (!std::regex_match (m_type, typeExpr))
    {
      ANA_MSG_ERROR ("type \"" << m_type << "\" does not match format expression");
      return StatusCode::FAILURE;
    }
    std::regex nameExpr;
    if (nestedNames)
      nameExpr = std::regex ("[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*(@[0-9]+)?");
    else
      nameExpr = std::regex ("[A-Za-z_][A-Za-z0-9_]*(@[0-9]+)?");
    if (!std::regex_match (m_name, nameExpr))
    {
      ANA_MSG_ERROR ("name \"" << m_name << "\" does not match format expression");
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

configureComponentExpert()

StatusCode asg::AsgComponentConfig::configureComponentExpert ( const std::string &  prefix, bool  nestedNames  ) const

inherited

add component configuration to configuration service (expert only)

In Athena we are not creating components (we leave that to the proper Athena services), but instead we load the configuration values up first, then ask for the component to be created the normal way. This makes sure that if we dump the configuration it will include this component, and as a bonus it avoids the whole issue of having to deal with Athena factory functions.

Guarantee

basic

Failures

configuration errors

Definition at line 364 of file AsgComponentConfig.cxx.

  {
    using namespace msgComponentConfig;
 
    ANA_CHECK (checkTypeName (nestedNames));
 
    ServiceHandle<Gaudi::Interfaces::IOptionsSvc> joSvc("JobOptionsSvc","AsgComponentConfig");
    ANA_CHECK (joSvc.retrieve());
 
    for (const auto& tool : m_privateTools)
    {
      ANA_CHECK (tool.second.m_config.configureComponentExpert (prefix + m_name + ".", true));
      if (tool.second.m_propName.empty())
      {
        std::string toolPath = prefix + m_name + "." + tool.first;
        joSvc->set (toolPath, tool.second.m_config.typeAndName());
      }
    }
 
    for (const auto& toolArray : m_toolArrays)
    {
      std::vector<std::string> valueArray;
      for (const auto& tool : toolArray.second)
      {
        auto toolConfig = m_privateTools.find (tool);
        if (toolConfig == m_privateTools.end())
        {
          ANA_MSG_ERROR ("Couldn't find private tool with name \"" << tool << "\"");
          ANA_MSG_ERROR ("This is an internal inconsistency!");
          return StatusCode::FAILURE;
        }
        valueArray.push_back (toolConfig->second.m_config.typeAndName());
      }
      std::string valueString = Gaudi::Utils::toString (valueArray);
      std::string propertyPath = prefix + m_name + "." + toolArray.first;
      joSvc->set (propertyPath, valueString);
    }
 
    for (const auto& property : m_propertyValues)
    {
      std::string propertyPath = prefix + m_name + "." + property.first;
      joSvc->set (propertyPath, property.second);
    }
 
    return StatusCode::SUCCESS;
  }

createPrivateTool()

StatusCode asg::AsgComponentConfig::createPrivateTool ( const std::string &  name, const std::string &  toolType  )

inherited

create a private tool of the given name and type

This is the only way you can configure tool properties through AsgComponentConfig: You need to add it the tool to the component configuration and then you can set individual properties on the tool, using the property name "tool.property".

If you want to add a subtool for a tool, you can do this by calling it "tool.subtool". Note that you will have to create both the tool and the subtool this way, i.e. you can't configure a subtool without also configuring the tool that owns it.

You can apply this to tools held by either ToolHandle or asg::AnaToolHandle, but if you configure a tool held by an AnaToolHandle this way it will completely replace teh tool configuration done in the component itself.

The calling convention is somewhat inverted compared to setTypeAndName() calls, but otherwise they would be inverted compared to the setProperty() calls. :(

Guarantee

strong

Failures

out of memory II

Definition at line 149 of file AsgComponentConfig.cxx.

  {
    return addPrivateTool (name, AsgComponentConfig(toolType + "/" + name));
  }

createPrivateToolInArray()

std::string asg::AsgComponentConfig::createPrivateToolInArray ( const std::string &  name, const std::string &  toolType  )

inherited

the array version of createPrivateTool

This returns the actual name of the tool to allow setting properties on it.

Guarantee

basic

Failures

out of memory II

Definition at line 158 of file AsgComponentConfig.cxx.

  {
    return addPrivateToolInArray (name, AsgComponentConfig(toolType + "/" + name));
  }

empty()

bool asg::AsgComponentConfig::empty ( ) const

noexceptinherited

whether all properties are unset

Guarantee

no-fail

Definition at line 63 of file AsgComponentConfig.cxx.

  {
    return
      m_type.empty() && m_name.empty() &&
      m_privateTools.empty() && m_propertyValues.empty();
  }

makePrivateTool() [1/2]

template<typename T >

::StatusCode asg::AsgToolConfig::makePrivateTool

(

ToolHandle< T > &

toolHandle

)

const

make a private tool with the given configuration

This requires a parent pointer to be set on the ToolHandle to work, and for the parent to derive from AsgComponent in AnalysisBase. That allows to attach the cleanup of the tool to the parent component.

For practical purposes, when using an AsgToolConfig to create a private tool owned by a parent tool/algorithm inside the initialize of the tool/algorithm, this is the preferred way of doing so.

Guarantee

basic

Failures

configuration errors
tool creation/initialization errors

makePrivateTool() [2/2]

template<typename T >

::StatusCode asg::AsgToolConfig::makePrivateTool

(

ToolHandle< T > &

toolHandle

)

const

Definition at line 188 of file AsgToolConfig.h.

  {
    using namespace msgComponentConfig;
 
    // This is safe, because the `makeTool` function in athena does
    // not use the cleanup argument.
    std::shared_ptr<void> cleanup;
    return makeTool (toolHandle, cleanup);
  }

makeTool() [1/2]

template<typename T >

::StatusCode asg::AsgToolConfig::makeTool	(	ToolHandle< T > &	toolHandle,
		std::shared_ptr< void > &	,
		bool	allowNestedName
	)		const

Definition at line 171 of file AsgToolConfig.h.

  {
    using namespace msgComponentConfig;
 
    std::string prefix = toolHandle.parentName() + ".";
 
    ANA_CHECK (configureComponentExpert (prefix, allowNestedName));
    toolHandle.setTypeAndName (type() + "/" + name());
    ANA_CHECK (toolHandle.retrieve());
 
    ANA_MSG_DEBUG ("Created component of type " << type());
    return StatusCode::SUCCESS;
  }

makeTool() [2/2]

template<typename T >

::StatusCode asg::AsgToolConfig::makeTool	(	ToolHandle< T > &	toolHandle,
		std::shared_ptr< void > &	cleanup,
		bool	allowNestedName = false
	)		const

make a tool with the given configuration

Note that the exact creational patterns are not determined yet (25 Mar 20), but presumably if you are using EventLoop you would rely on EventLoop to create your tool from this object. For use within unit tests we may use this method, but we may also change the signature.

We may also use this class as a replacement for AnaToolHandle in which case this would at least have to be updated to at the very least work on a ToolHandle, but so far this code isn't even dual-use.

The argument allowNestedName should probably be omitted in most cases. I mostly added it to allow AnaToolHandle to create new tools via an AsgToolConfig (06 Jan 21), for which a number of existing users rely on making nested names. Usually when you want a nested name you ought to set the parent on the ToolHandle and then use a non-nested name for the name of the config.

Guarantee

basic

Failures

configuration errors
tool creation/initialization errors

name()

const std::string & asg::AsgComponentConfig::name ( ) const

noexceptinherited

the name of the component

Guarantee

no-fail

Definition at line 89 of file AsgComponentConfig.cxx.

  {
    return m_name;
  }

setName()

void asg::AsgComponentConfig::setName ( const std::string &  val_name )

inherited

set the value of name

Guarantee

strong

Failures

out of memory II

Definition at line 97 of file AsgComponentConfig.cxx.

  {
    m_name = val_name;
  }

setProperty()

template<typename T >

StatusCode asg::AsgComponentConfig::setProperty ( const std::string &  name, const T &  value  )

inherited

set the given property

Guarantee

strong

Failures

could not convert to string
out of memory II

setPropertyFromString()

void asg::AsgComponentConfig::setPropertyFromString ( const std::string &  name, const std::string &  value  )

inherited

set a given property from a string value

Guarantee

strong

Failures

out of memory II

Definition at line 132 of file AsgComponentConfig.cxx.

  {
    auto split = name.find ('.');
    if (split == std::string::npos)
    {
      m_propertyValues[name] = value;
    } else
    {
      auto subtool = accessSubtool (name, split);
      subtool.config->setPropertyFromString (subtool.name, value);
    }
  }

setType()

void asg::AsgComponentConfig::setType ( const std::string &  val_type )

inherited

set the value of type

Guarantee

strong

Failures

out of memory II

Definition at line 81 of file AsgComponentConfig.cxx.

  {
    m_type = val_type;
  }

setTypeAndName()

void asg::AsgComponentConfig::setTypeAndName ( const std::string &  val_typeAndName )

inherited

set type and name at the same time

Guarantee

basic

Failures

out of memory II

Definition at line 115 of file AsgComponentConfig.cxx.

  {
    const auto split = val_typeAndName.find ('/');
    if (split == std::string::npos)
    {
      setType (val_typeAndName);
      setName (val_typeAndName);
    } else
    {
      setType (val_typeAndName.substr (0,split));
      setName (val_typeAndName.substr (split+1));
    }
  }

type()

const std::string & asg::AsgComponentConfig::type ( ) const

noexceptinherited

the type of the component

Guarantee

no-fail

Definition at line 73 of file AsgComponentConfig.cxx.

  {
    return m_type;
  }

typeAndName()

std::string asg::AsgComponentConfig::typeAndName ( ) const

inherited

get type and name at the same time

Guarantee

basic

Failures

out of memory II

Definition at line 105 of file AsgComponentConfig.cxx.

  {
    if (m_name == m_type)
      return m_name;
    return m_type + "/" + m_name;
  }

Member Data Documentation

m_name

std::string asg::AsgComponentConfig::m_name

privateinherited

the value of name

Definition at line 278 of file AsgComponentConfig.h.

m_privateTools

std::map<std::string, details::AsgComponentPrivateToolConfig> asg::AsgComponentConfig::m_privateTools

privateinherited

the map of (private) tools to create

Definition at line 281 of file AsgComponentConfig.h.

m_propertyValues

std::map<std::string,std::string> asg::AsgComponentConfig::m_propertyValues

privateinherited

the map of property values

Definition at line 288 of file AsgComponentConfig.h.

m_toolArrays

std::map<std::string,std::vector<std::string> > asg::AsgComponentConfig::m_toolArrays

privateinherited

the map of (private) tool handle arrays to manage, and the tools they contain

Definition at line 285 of file AsgComponentConfig.h.

m_type

std::string asg::AsgComponentConfig::m_type

privateinherited

the value of type

Definition at line 275 of file AsgComponentConfig.h.

---

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

• AsgToolConfig.h
• AsgToolConfig.cxx