AsgComponent.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef ASGTOOLS_ASGCOMPONENT_H
#define ASGTOOLS_ASGCOMPONENT_H
 
#if !defined(XAOD_STANDALONE) && !defined(__CPPCHECK__)
#error "This header should only be used in XAOD_STANDALONE"
#else
 
#include <AsgMessaging/AsgMessaging.h>
#include <AsgMessaging/INamedInterface.h>
#include <AsgMessaging/MessageCheck.h>
#include <AsgMessaging/MsgLevel.h>
#include <AsgTools/Interfaces.h>
#include <memory>
#include <vector>
 
class Property;
class PropertyMgr;
 
namespace asg
{
 
  class AsgComponent : public virtual INamedInterface,
                       public AsgMessaging
  {
    //
    // public interface
    //
 
    AsgComponent (const AsgComponent&) = delete;
    AsgComponent& operator = (const AsgComponent&) = delete;
 
  public:
    AsgComponent (const std::string& val_name);
 
 
  public:
    ~AsgComponent() noexcept;
 
 
  public:
    void addCleanup (const std::shared_ptr<void>& cleanup);
 
 
 
    //
    // properties interface
    //
 
  public:
    template<typename T> Property *
    declareProperty (const std::string& name, T& loc,
                     const std::string& doc = "");
 
 
  public:
    template<typename T> ::StatusCode
    setProperty (const std::string& name, const T& value);
    ::StatusCode setProperty (const std::string& name, const char *value);
 
 
    PropertyMgr *getPropertyMgr () noexcept;
    const PropertyMgr* getPropertyMgr() const noexcept;
 
 
 
    //
    // inherited interface
    //
 
  public:
    virtual const std::string& name() const override;
 
 
 
    //
    // private interface
    //
 
    // for some reason AsgTool allows to set/override the tool name
    // and be able to get properties/the property manager.  this
    // friend declaration allows that.
    friend class AsgTool;
 
  private:
    std::string m_name;
 
  private:
    PropertyMgr *m_properties {nullptr};
 
  private:
    std::vector<std::shared_ptr<void> > m_cleanup;
  };
}
 
#include "AsgTools/AsgComponent.icc"
 
#endif
#endif