D3PD::CollectionGetterRegistryTool Class Reference

Tool to keep a registry of collection getter tools. More...

#include <CollectionGetterRegistryTool.h>

Inheritance diagram for D3PD::CollectionGetterRegistryTool:

Collaboration diagram for D3PD::CollectionGetterRegistryTool:

Public Member Functions
	CollectionGetterRegistryTool (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	add (const std::string &label, ICollectionGetterTool *tool)
	Register a new collection getter tool. More...
virtual StatusCode	get (const std::string &label, const INamedInterface *parent, ICollectionGetterTool *&tool)
	Get a copy of a registered collection getter tool. More...

Private Types
typedef std::unordered_map< std::string, D3PD::ICollectionGetterTool * >	map_t
	Map from getter labels to instances. More...

Private Attributes
ServiceHandle< Gaudi::Interfaces::IOptionsSvc >	m_jos
	Property: The job options service. More...
ServiceHandle< IToolSvc >	m_toolsvc
	Property: The tool service. More...
map_t	m_collection_map

Detailed Description

Tool to keep a registry of collection getter tools.

In order to represent associations by an index, we need to be able to get access to the collection within which we're indexing. We do this by optionally associating a label with a collection getter tool (this will typically be the object prefix). We can then look up the label here and make a copy of the matching getter tool. (We make a copy rather than using the original instance since the collection getters are stateful.)

Definition at line 45 of file CollectionGetterRegistryTool.h.

Member Typedef Documentation

map_t

typedef std::unordered_map<std::string, D3PD::ICollectionGetterTool*> D3PD::CollectionGetterRegistryTool::map_t

private

Map from getter labels to instances.

Definition at line 95 of file CollectionGetterRegistryTool.h.

Constructor & Destructor Documentation

CollectionGetterRegistryTool()

D3PD::CollectionGetterRegistryTool::CollectionGetterRegistryTool	(	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 29 of file CollectionGetterRegistryTool.cxx.

    : base_class (type, name, parent),
      m_jos       ("JobOptionsSvc", name),
      m_toolsvc   ("ToolSvc",       name)
{
  declareProperty ("JobOptionsSvc", m_jos,
                   "The JobOptionsSvc instance.");
  declareProperty ("ToolSvc",       m_toolsvc,
                   "The ToolSvc instance.");
}

Member Function Documentation

add()

StatusCode D3PD::CollectionGetterRegistryTool::add ( const std::string &  label, ICollectionGetterTool *  tool  )

virtual

Register a new collection getter tool.

Parameters

label	Label for the tool.
tool	The tool instance.

Definition at line 62 of file CollectionGetterRegistryTool.cxx.

{
  std::pair<map_t::iterator, bool> res =
    m_collection_map.insert (std::make_pair (label, tool));
  if (!res.second) {
    REPORT_MESSAGE_WITH_CONTEXT (MSG::ERROR,
                                 "D3PD::CollectionGetterRegistryTool")
      << "Duplicate collection label " << label
      << " for tools " << res.first->second->name()
      << " and " << tool->name();
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

get()

StatusCode D3PD::CollectionGetterRegistryTool::get ( const std::string &  label, const INamedInterface *  parent, ICollectionGetterTool *&  tool  )

virtual

Get a copy of a registered collection getter tool.

Parameters

label	Label for the tool.
parent	Parent for the new tool.
tool	The new tool instance.

The new tool will be a private tool, owned by parent.

Definition at line 88 of file CollectionGetterRegistryTool.cxx.

{
  // Loop up the tool in the map.
  tool = 0;
  map_t::iterator i = m_collection_map.find (label);
  if (i == m_collection_map.end()) {
    REPORT_MESSAGE_WITH_CONTEXT (MSG::WARNING,
                                 "D3PD::CollectionGetterRegistryTool")
      << "Can't find collection label " << label;
    std::ostringstream os;
    os << "  Known collections:";
    for (const auto& p : m_collection_map) {
      os << " " << p.first;
    }
    REPORT_MESSAGE_WITH_CONTEXT (MSG::WARNING,
                                 "D3PD::CollectionGetterRegistryTool")
      << os.str();
    return StatusCode::SUCCESS;
  }
 
  // Get the properties for the source tool.
  const auto& props = m_jos->items([&i](const auto& p) {
    return std::get<0>(p).starts_with( i->second->name()+".");
  });
 
  // Copy them to the destination tool (except for Label).
  std::string fullname = parent->name() + "." + label;
  for (const auto& p : props) {
    const std::string& oldname = std::get<0>(p);
    std::string::size_type ipos = oldname.rfind ('.');
    if (ipos != std::string::npos) {
      std::string pname = oldname.substr (ipos, std::string::npos);
      if (pname != ".Label") {
        m_jos->set(fullname + pname, std::get<1>(p));
      }
    }
  }
 
  // Create the new tool.
  return m_toolsvc->retrieveTool (i->second->type(), label, tool, parent);
}

initialize()

StatusCode D3PD::CollectionGetterRegistryTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 48 of file CollectionGetterRegistryTool.cxx.

{
  CHECK( AthAlgTool::initialize() );
  CHECK( m_jos.retrieve() );
  CHECK( m_toolsvc.retrieve() );
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_collection_map

map_t D3PD::CollectionGetterRegistryTool::m_collection_map

private

Definition at line 96 of file CollectionGetterRegistryTool.h.

m_jos

ServiceHandle<Gaudi::Interfaces::IOptionsSvc> D3PD::CollectionGetterRegistryTool::m_jos

private

Property: The job options service.

Definition at line 89 of file CollectionGetterRegistryTool.h.

m_toolsvc

ServiceHandle<IToolSvc> D3PD::CollectionGetterRegistryTool::m_toolsvc

private

Property: The tool service.

Definition at line 92 of file CollectionGetterRegistryTool.h.

---

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

• CollectionGetterRegistryTool.h
• CollectionGetterRegistryTool.cxx