asg::ToolStore Class Reference

A light-weight replacement for ToolSvc for ROOT analysis. More...

#include <ToolStore.h>

Collaboration diagram for asg::ToolStore:

Static Public Member Functions
static StatusCode	put (IAsgTool *ptool)
	Store a named tool by its name.
static IAsgTool *	get (const std::string &name, bool silent=false)
	Retrieve a tool by name.
template<typename T>
static T *	get (const std::string &name)
	Retrieve a tool by name and interface.
template<typename T>
static bool	contains (const std::string &name)
	Check whether a tool with a given type and name is known in the store.
static StatusCode	remove (const IAsgTool *tool)
	Remove the specified tool from the store.
static StatusCode	remove (const std::string &name)
	Remove a tool with a given name from the store.

Detailed Description

A light-weight replacement for ToolSvc for ROOT analysis.

In order to allow tools to find each other through ToolHandles, just like in Athena, we need a global registry of all of the tools that the user instantiates in his/her job.

This class does exactly this. All created dual-use tools register themselves in it, so that other components could later on find them.

Author

David Adams dlada.nosp@m.ms@b.nosp@m.nl.go.nosp@m.v

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision

802972

Date

2017-04-15 20:13:17 +0200 (Sat, 15 Apr 2017)

Definition at line 32 of file ToolStore.h.

Member Function Documentation

contains()

template<typename T>

bool asg::ToolStore::contains ( const std::string & name )

inlinestatic

Check whether a tool with a given type and name is known in the store.

Definition at line 51 of file ToolStore.h.

                                                    {
 
         return ( dynamic_cast< T* >( get( name, true ) ) != 0 );
      }

get() [1/2]

template<typename T>

T * asg::ToolStore::get ( const std::string & name )

inlinestatic

Retrieve a tool by name and interface.

Definition at line 44 of file ToolStore.h.

                                             {
 
         return dynamic_cast< T* >( get( name ) );
      }

get() [2/2]

IAsgTool * asg::ToolStore::get ( const std::string & name, bool silent = false )

static

Retrieve a tool by name.

Definition at line 57 of file ToolStore.cxx.

                                                                {
      using namespace msgToolStore;
 
      std::lock_guard<std::mutex> lock (s_toolMutex);
      ToolMap_t::const_iterator itool = s_tools.find( name );
      if( itool != s_tools.end() )
        return itool->second;
 
      if (name.compare(0, 8, "ToolSvc.") != 0) {
        itool = s_tools.find( "ToolSvc." + name );
        if( itool != s_tools.end() )
          return itool->second;
      }
 
      if( ! silent ) {
        ANA_MSG_WARNING ("Tool with name \"" << name << "\" not found");
      }
      return nullptr;
   }

put()

StatusCode asg::ToolStore::put ( IAsgTool * ptool )

static

Store a named tool by its name.

The name must be non-blank and not already exist in the store.

Definition at line 28 of file ToolStore.cxx.

                                              {
      using namespace msgToolStore;
 
      // Start with a little sanity check:
      if( ! ptool ) {
         ANA_MSG_ERROR( "asg::ToolStore::put: Received a null pointer" );
         return StatusCode::FAILURE;
      }
 
      // Get and check the name of the tool:
      const std::string& name = ptool->name();
      if( ! name.size() ) {
         ANA_MSG_ERROR( "asg::ToolStore::put: The received tool doesn't have a name" );
         return StatusCode::FAILURE;
      }
 
      std::lock_guard<std::mutex> lock (s_toolMutex);
      // Check whether we already have a tool with this name:
      if( s_tools.find( name ) != s_tools.end() ) {
         ANA_MSG_WARNING ("asg::ToolStore::put: Tool with name \""
                        << name << "\" already registered");
         return StatusCode::FAILURE;
      }
 
      // Remember the tool:
      s_tools[ name ] = ptool;
      return StatusCode::SUCCESS;
   }

remove() [1/2]

StatusCode asg::ToolStore::remove ( const IAsgTool * tool )

static

Remove the specified tool from the store.

Definition at line 77 of file ToolStore.cxx.

                                                      {
 
      // Delegate the call to the other function:
      return remove( tool->name() );
   }

remove() [2/2]

StatusCode asg::ToolStore::remove ( const std::string & name )

static

Remove a tool with a given name from the store.

Definition at line 83 of file ToolStore.cxx.

                                                       {
 
      std::lock_guard<std::mutex> lock (s_toolMutex);
      // Remove the tool, not checking if the call was successful or not:
      s_tools.erase( name );
      return StatusCode::SUCCESS;
   }

---

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

• ToolStore.h
• ToolStore.cxx