AsgComponentConfig.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
 
 
 
#ifndef ASG_TOOLS__ASG_COMPONENT_CONFIG_H
#define ASG_TOOLS__ASG_COMPONENT_CONFIG_H
 
// Athena include(s).
#include "AsgMessaging/StatusCode.h"
 
// System include(s).
#include <map>
#include <memory>
#include <string>
#include <vector>
 
namespace asg
{
  namespace details
  {
    // Forward declaration of the private tool configuration type
    struct AsgComponentPrivateToolConfig;
  }
 
 
  class AsgComponentConfig
  {
    //
    // public interface
    //
 
  public:
    AsgComponentConfig () = default;
 
 
  public:
    explicit AsgComponentConfig (const std::string& val_typeAndName);
 
 
  public:
    bool empty () const noexcept;
 
 
  public:
    const std::string& type () const noexcept;
 
  public:
    void setType (const std::string& val_type);
 
 
  public:
    const std::string& name () const noexcept;
 
  public:
    void setName (const std::string& val_name);
 
 
  public:
    std::string typeAndName () const;
 
 
  public:
    void setTypeAndName (const std::string& val_typeAndName);
 
 
  public:
    template<typename T> StatusCode
    setProperty (const std::string& name, const T& value);
 
 
  public:
    void setPropertyFromString (const std::string& name,
                                const std::string& value);
 
 
  public:
    StatusCode createPrivateTool (const std::string& name,
                                  const std::string& toolType);
 
 
  public:
    StatusCode addPrivateTool (const std::string& name,
                               AsgComponentConfig toolConfig);
 
 
  public:
    std::string createPrivateToolInArray (const std::string& name,
                                          const std::string& toolType);
 
 
  public:
    std::string addPrivateToolInArray (const std::string& name,
                                       AsgComponentConfig toolConfig);
 
 
 
#ifdef XAOD_STANDALONE
  public:
    template<typename T> StatusCode
    makeComponentExpert (std::unique_ptr<T>& component,
                         const std::string& newCommand,
                         bool nestedNames, std::string prefix) const;
#endif
 
 
#ifndef XAOD_STANDALONE
  public:
    StatusCode
    configureComponentExpert (const std::string& prefix,
                              bool nestedNames) const;
#endif
 
 
 
    //
    // private interface
    //
 
  private:
 
    std::string m_type;
 
    std::string m_name;
 
    std::map<std::string, details::AsgComponentPrivateToolConfig> m_privateTools;
 
    std::map<std::string,std::vector<std::string>> m_toolArrays;
 
    std::map<std::string,std::string> m_propertyValues;
 
 
    StatusCode checkTypeName (bool nestedNames) const;
 
 
    struct AccessSubtoolData final
    {
      AsgComponentConfig *config {nullptr};
      std::string prefix;
      std::string name;
    };
    AccessSubtoolData accessSubtool (const std::string& name,
                                     std::size_t split);
  };
 
  namespace details {
 
    struct AsgComponentPrivateToolConfig {
      AsgComponentConfig m_config;
      std::string m_propName;
    };
 
  } // namespace details
} // namespace asg
 
#include "AsgComponentConfig.icc"
 
#endif