EIC code displayed by LXR master/​include/​ActsExamples/​Framework/​WhiteBoard.hpp	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-07-15 08:27:39

 // This file is part of the Acts project.
 //
 // Copyright (C) 2017-2019 CERN for the benefit of the Acts project
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 #pragma once
 
 #include <Acts/Utilities/Concepts.hpp>
 #include <Acts/Utilities/Logger.hpp>
 
 #include <algorithm>
 #include <cstddef>
 #include <memory>
 #include <ostream>
 #include <stdexcept>
 #include <string>
 #include <string_view>
 #include <type_traits>
 #include <typeinfo>
 #include <unordered_map>
 #include <utility>
 #include <vector>
 
 namespace ActsExamples {
 
 /// A container to store arbitrary objects with ownership transfer.
 ///
 /// This is an append-only container that takes ownership of the objects
 /// added to it. Once an object has been added, it can only be read but not
 /// be modified. Trying to replace an existing object is considered an error.
 /// Its lifetime is bound to the lifetime of the white board.
 class WhiteBoard {
  public:
   WhiteBoard(std::unique_ptr<const Acts::Logger> logger =
                  Acts::getDefaultLogger("WhiteBoard", Acts::Logging::INFO),
              std::unordered_map<std::string, std::string> objectAliases = {});
 
   // A WhiteBoard holds unique elements and can not be copied
   WhiteBoard(const WhiteBoard& other) = delete;
   WhiteBoard& operator=(const WhiteBoard&) = delete;
 
   bool exists(const std::string& name) const;
 
  private:
   /// Store an object on the white board and transfer ownership.
   ///
   /// @param name Non-empty identifier to store it under
   /// @param object Movable reference to the transferable object
   /// @throws std::invalid_argument on empty or duplicate name
   template <typename T>
   void add(const std::string& name, T&& object);
 
   /// Get access to a stored object.
   ///
   /// @param[in] name Identifier for the object
   /// @return reference to the stored object
   /// @throws std::out_of_range if no object is stored under the requested name
   template <typename T>
   const T& get(const std::string& name) const;
 
  private:
   /// Find similar names for suggestions with levenshtein-distance
   std::vector<std::string_view> similarNames(const std::string_view& name,
                                              int distThreshold,
                                              std::size_t maxNumber) const;
 
   // type-erased value holder for move-constructible types
   struct IHolder {
     virtual ~IHolder() = default;
     virtual const std::type_info& type() const = 0;
   };
   template <Acts::Concepts::nothrow_move_constructible T>
   struct HolderT : public IHolder {
     T value;
 
     HolderT(T&& v) : value(std::move(v)) {}
     const std::type_info& type() const override { return typeid(T); }
   };
 
   std::unique_ptr<const Acts::Logger> m_logger;
   std::unordered_map<std::string, std::shared_ptr<IHolder>> m_store;
   std::unordered_map<std::string, std::string> m_objectAliases;
 
   const Acts::Logger& logger() const { return *m_logger; }
 
   static std::string typeMismatchMessage(const std::string& name,
                                          const char* req, const char* act);
 
   template <typename T>
   friend class WriteDataHandle;
 
   template <typename T>
   friend class ReadDataHandle;
 };
 
 }  // namespace ActsExamples
 
 inline ActsExamples::WhiteBoard::WhiteBoard(
     std::unique_ptr<const Acts::Logger> logger,
     std::unordered_map<std::string, std::string> objectAliases)
     : m_logger(std::move(logger)), m_objectAliases(std::move(objectAliases)) {}
 
 template <typename T>
 inline void ActsExamples::WhiteBoard::add(const std::string& name, T&& object) {
   if (name.empty()) {
     throw std::invalid_argument("Object can not have an empty name");
   }
   if (0 < m_store.count(name)) {
     throw std::invalid_argument("Object '" + name + "' already exists");
   }
   auto holder = std::make_shared<HolderT<T>>(std::forward<T>(object));
   m_store.emplace(name, holder);
   ACTS_VERBOSE("Added object '" << name << "' of type " << typeid(T).name());
   if (auto it = m_objectAliases.find(name); it != m_objectAliases.end()) {
     m_store[it->second] = holder;
     ACTS_VERBOSE("Added alias object '" << it->second << "'");
   }
 }
 
 template <typename T>
 inline const T& ActsExamples::WhiteBoard::get(const std::string& name) const {
   ACTS_VERBOSE("Attempt to get object '" << name << "' of type "
                                          << typeid(T).name());
   auto it = m_store.find(name);
   if (it == m_store.end()) {
     const auto names = similarNames(name, 10, 3);
 
     std::stringstream ss;
     if (!names.empty()) {
       ss << ", similar ones are: [ ";
       for (std::size_t i = 0; i < std::min(3ul, names.size()); ++i) {
         ss << "'" << names[i] << "' ";
       }
       ss << "]";
     }
 
     throw std::out_of_range("Object '" + name + "' does not exists" + ss.str());
   }
 
   const IHolder* holder = it->second.get();
 
   const auto* castedHolder = dynamic_cast<const HolderT<T>*>(holder);
   if (castedHolder == nullptr) {
     std::string msg =
         typeMismatchMessage(name, typeid(T).name(), holder->type().name());
     throw std::out_of_range(msg.c_str());
   }
 
   ACTS_VERBOSE("Retrieved object '" << name << "'");
   return castedHolder->value;
 }
 
 inline bool ActsExamples::WhiteBoard::exists(const std::string& name) const {
   return m_store.find(name) != m_store.end();
 }

This page was automatically generated by the 2.3.7 LXR engine. The LXR team