---

ToolSvc.h

Go to the documentation of this file.

// $Header: /nfs/slac/g/glast/ground/cvs/GaudiSvc/src/ToolSvc/ToolSvc.h,v 1.1.1.2 2001/04/18 18:32:51 tlindner Exp $
#ifndef ToolSVC_ToolSVC_H
#define ToolSVC_ToolSVC_H

// Include Files
#include "GaudiKernel/Service.h"
#include "GaudiKernel/IObjManager.h"
#include "GaudiKernel/IToolSvc.h"

// Forward declarations
template <class TYPE> class SvcFactory;

//------------------------------------------------------------------
//
// ClassName:   ToolSvc
//  
// Description: This service manages tools. 
//              Tools can be common, in which case a single instance
//              can be shared by different algorithms, or private
//              in which case it is necessary to specify the parent
//              when requesting it.
//              The parent of a tool can be an algortihm or a Service
//              The environment of a tool is set by using that of the
//              parent. A common tool is considered to belong to the
//              ToolSvc itself.
//              Note that this is a prototype version.
//              
// Author:      G.Corti, P.Mato
//------------------------------------------------------------------

class ToolSvc : public Service, virtual public IToolSvc {

public: 
  
// Typedefs 
  typedef std::list<IAlgTool*>     ListTools;

// Inherited Service overrides:
//
  // Initialise the service.
  virtual StatusCode initialize();
  
  // Finalise the service.
  virtual StatusCode finalize();
  
  // Query the interfaces.
  //   Input: riid, Requested interface ID
  //          ppvInterface, Pointer to requested interface
  //   Return: StatusCode indicating SUCCESS or FAILURE.
  // N.B. Don't forget to release the interface after use!!!
  virtual StatusCode queryInterface( const IID& riid, void** ppvInterface );
    
// IToolSvc interfaces overwrite
// 
  // Retrieve tool, create it by default as common tool if it does not already exist
  virtual StatusCode retrieve(const std::string& type, IAlgTool*& tool, const IInterface* parent,
                                  bool createIf); 
  
  virtual StatusCode retrieve(const std::string& tooltype, const std::string& toolname,  
                                  IAlgTool*& tool, const IInterface* parent, bool createIf);


// Additional methods not in the interfaces  
//
  // Create Tool standard way with automatically assigned name
  StatusCode create(const std::string& type, const IInterface* parent, 
                            IAlgTool*& tool);

  // Create Tool standard way with specified name
  StatusCode create(const std::string& type, const std::string& name, 
                            const IInterface* parent, IAlgTool*& tool);

  // Check if the tool instance exists
  bool existsTool( const std::string& toolname) const;

  // Get Tool full name by combining nameByUser and "parent" part
  std::string nameTool(const std::string& nameByUser, const IInterface* parent);

protected:
  
  // Standard Constructor.
  //   Input:  name   String with service name
  //   Input:  svc    Pointer to service locator interface
  ToolSvc( const std::string& name, ISvcLocator* svc );
  
  // Destructor.
  virtual ~ToolSvc();

private:
  // Allow SvcFactory to instantiate the service.
  friend class SvcFactory<ToolSvc>;

  // Manager of the AlgTool Objects
  IObjManager* m_objManager;             

  // Common Tools
  ListTools*    m_instancesTools;        // List of all instances of tools

};

#endif

---