IToolSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/IInterface.h>
#include <GaudiKernel/System.h>
#include <functional>
#include <list>
#include <string>
 
// Forward declaration
class IAlgTool;

class GAUDI_API IToolSvc : virtual public IInterface {
public:
  DeclareInterfaceID( IToolSvc, 2, 1 );
 
  // Typedefs
  typedef std::list<IAlgTool*> ListTools;

  virtual StatusCode retrieve( std::string_view type, const InterfaceID& iid, IAlgTool*& tool,
                               const IInterface* parent = 0, bool createIf = true ) = 0;

  virtual StatusCode retrieve( std::string_view type, std::string_view name, const InterfaceID& iid, IAlgTool*& tool,
                               const IInterface* parent = 0, bool createIf = true ) = 0;

  virtual std::vector<std::string> getInstances( std::string_view toolType ) = 0;

  virtual std::vector<std::string> getInstances() const = 0;

  virtual std::vector<IAlgTool*> getTools() const = 0;

  virtual StatusCode releaseTool( IAlgTool* tool ) = 0;

  template <class T>
  StatusCode retrieveTool( std::string_view type, T*& tool, const IInterface* parent = nullptr, bool createIf = true ) {
    IAlgTool*  ialgtool{ nullptr };
    StatusCode sc = retrieve( type, T::interfaceID(), ialgtool, parent, createIf );
    tool          = Gaudi::Cast<T>( ialgtool );
    return sc;
  }

  template <class T>
  StatusCode retrieveTool( std::string_view type, std::string_view name, T*& tool, const IInterface* parent = nullptr,
                           bool createIf = true ) {
    IAlgTool*  ialgtool{ nullptr };
    StatusCode sc = retrieve( type, name, T::interfaceID(), ialgtool, parent, createIf );
    tool          = Gaudi::Cast<T>( ialgtool );
    return sc;
  }

  class Observer {
  public:
    virtual ~Observer() {
      if ( m_unregister ) m_unregister();
    }
    void setUnregister( std::function<void()> unregister ) { m_unregister = std::move( unregister ); }
 
    virtual void onCreate( const IAlgTool* ) {}
    virtual void onRetrieve( const IAlgTool* ) {}
 
  private:
    std::function<void()> m_unregister;
  };
 
  virtual void registerObserver( Observer* obs ) = 0;
};