ToolSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 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.                                             *
\***********************************************************************************/
#ifndef GAUDISVC_TOOLSVC_H
#define GAUDISVC_TOOLSVC_H

// Include Files
#include "GaudiKernel/IHistorySvc.h"
#include "GaudiKernel/IToolSvc.h"
#include "GaudiKernel/Service.h"
#include <mutex>
#include <vector>

class ToolSvc : public extends<Service, IToolSvc> {

public:
  using extends::extends;

  ~ToolSvc() override;
  StatusCode initialize() override;

  StatusCode finalize() override;

  // Start transition for tools
  StatusCode start() override;

  // Stop transition for tools
  StatusCode stop() override;

  StatusCode retrieve( const std::string& type, const InterfaceID& iid, IAlgTool*& tool, const IInterface* parent,
                       bool createIf ) override;

  StatusCode retrieve( const std::string& tooltype, const std::string& toolname, const InterfaceID& iid,
                       IAlgTool*& tool, const IInterface* parent, bool createIf ) override;

  std::vector<std::string> getInstances( const std::string& toolType ) override;

  std::vector<std::string> getInstances() const override;

  std::vector<IAlgTool*> getTools() const override;

  StatusCode releaseTool( IAlgTool* tool ) override;

  StatusCode create( const std::string& type, const IInterface* parent, IAlgTool*& tool );

  StatusCode create( const std::string& type, const std::string& name, const IInterface* parent, IAlgTool*& tool );

  bool existsTool( const std::string& toolname ) const;

  std::string nameTool( const std::string& nameByUser, const IInterface* parent );

  void registerObserver( IToolSvc::Observer* obs ) override;

private: // methods
  // helper functions
  //
  unsigned long totalToolRefCount() const;
  unsigned long minimumToolRefCount() const;

  StatusCode finalizeTool( IAlgTool* itool ) const;

private: // data
  std::vector<IAlgTool*> m_instancesTools; // List of all instances of tools

  IHistorySvc* m_pHistorySvc = nullptr;

  std::vector<IToolSvc::Observer*> m_observers;

  typedef std::recursive_mutex CallMutex;
  mutable CallMutex            m_mut;
};

#endif