AsgTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ASGTOOLS_ASGTOOL_H
#define ASGTOOLS_ASGTOOL_H
 
// Athena include(s).
#include "SGCore/sgkey_t.h"
 
// Local include(s):
#include "AsgTools/IAsgTool.h"
#include "AsgMessaging/MsgLevel.h"
#include "AsgMessaging/MessageCheck.h"
 
// Environment specific include(s):
#ifdef XAOD_STANDALONE
#   include "AsgMessaging/AsgMessaging.h"
#   include "AsgTools/AsgComponent.h"
#   include "AsgTools/SgEvent.h"
   // Forward declaration(s):
#else // XAOD_STANDALONE
#   include "AthenaBaseComps/AthAlgTool.h"
#endif // XAOD_STANDALONE
 
// System include(s).
#include <string>
 
namespace asg {
 
   // Declare the type name of AsgTool's base class
#ifndef XAOD_STANDALONE
   typedef ::AthAlgTool AsgToolBase;
#else // not XAOD_STANDALONE
   typedef AsgComponent AsgToolBase;
#endif // not XAOD_STANDALONE

   class AsgTool : public virtual IAsgTool,
                   public AsgToolBase {
 
   public:
      AsgTool( const std::string& name );
      ~AsgTool();
 
      AsgTool (const AsgTool&) = delete;
      AsgTool& operator= (const AsgTool&) = delete;
 
 
#ifdef XAOD_STANDALONE

      SgEvent* evtStore() const;
 
     // this is just so that my template functions can find this
     // method in the base class.
   public:
     using AsgToolBase::msg;
 
#endif // XAOD_STANDALONE
 
#ifndef XAOD_STANDALONE
   public:
      using ::AthAlgTool::getProperty;
 
#endif // not XAOD_STANDALONE


      template< class T >
      const T* getProperty( const std::string& name ) const;

      const std::string& msg_level_name() const __attribute__ ((deprecated));

      const std::string& getName( const void* ptr ) const;

      SG::sgkey_t getKey( const void* ptr ) const;


      virtual StatusCode initialize() { return StatusCode::SUCCESS; }

      virtual void print() const;
 
   private:
#ifdef XAOD_STANDALONE
      mutable SgEvent m_event; 
#endif // XAOD_STANDALONE
 
   }; // class AsgTool
 
} // namespace asg
 
// Include the implementation of the template functions:
#include "AsgTools/AsgTool.icc"
 
// Include static methods for working with AsgTools
#include "AsgTools/SetProperty.h"
 
#endif // ASGTOOLS_ASGTOOL_H