ToolHandle.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ASGTOOLS_TOOLHANDLE_H
#define ASGTOOLS_TOOLHANDLE_H
 
// Local include(s):
#ifndef XAOD_STANDALONE
#   include "GaudiKernel/ToolHandle.h"
#else // not XAOD_STANDALONE
 
// System include(s):
#include <string>
#include <iosfwd>
 
// Local include(s):
#include "AsgMessaging/StatusCode.h"
 
class INamedInterface;

class ToolHandleBase {
 
public:
   ToolHandleBase( const std::string& typeAndName = "", INamedInterface* parent = 0 );

   const std::string& typeAndName() const;
   const std::string& type() const;
   const std::string& name() const;
   const std::string& parentName() const;
   INamedInterface *parent() const noexcept;

   void setTypeAndName(const std::string& typeAndName);
   void setName(const std::string& name);
 
protected:
   std::string m_typeAndName;
   std::string m_type;
   std::string m_name;
   INamedInterface *m_parent;
 
}; // class ToolHandleBase

template< class T >
class ToolHandle : public ToolHandleBase {
 
public:
   typedef T value_type;

   ToolHandle( T* ptool = 0 );

   ToolHandle( const std::string& toolname, INamedInterface* parent = 0 );

   template<typename T2>
   ToolHandle (T2 *parent, const std::string& propertyName,
               const std::string& toolName,
               const std::string& propertyTitle = "");

   T& operator*();
   const T& operator*() const;
   T* operator->();
   const T* operator->() const;

   StatusCode retrieve() const;

   void disable () noexcept;

   bool empty() const;

   bool isSet() const;
 
private:
   mutable T* m_ptool {nullptr};
 
}; // class ToolHandle

template< class T >
std::ostream& operator<< ( std::ostream& out,
                           const ToolHandle< T >& handle );
 
// Include the implementation of the code:
#include "AsgTools/ToolHandle.icc"
 
#endif // not XAOD_STANDALONE
#endif // ASGTOOLS_TOOLHANDLE_H