bank_base.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026, Liam Pohlmann
 
#ifndef HUMMINGBIRD_BANKS_BANK_BASE_H_
#define HUMMINGBIRD_BANKS_BANK_BASE_H_
 
#include <nlohmann/json.hpp>
#include <string>
#include <unordered_map>
 
using nlohmann::json;
 
namespace hummingbird {
/**
 * @brief Base class for banks that store objects of type T by integer ID and
 * look them up by the name given in the JSON input file
 *
 * @tparam T Stored object type
 */
template <typename T>
class BankBase {
 public:
  /**
   * @brief Get the object by its ID
   *
   * @param id ID
   * @return const T&
   */
  const T& GetByID(const int id) const { return id_object_map_.at(id); }
 
  /**
   * @brief Get the object by its name in the JSON input file
   *
   * @param name Object name
   * @return const T&
   */
  const T& GetByName(const std::string& name) const {
    return GetByID(name_id_map_.at(name));
  }
 
  /**
   * @brief Get the ID of an object by its name in the JSON input file
   *
   * @param name Object name
   * @return  int
   */
  int GetIDByName(const std::string& name) const {
    return name_id_map_.at(name);
  }
 
 protected:
  /// @brief ID to object map
  std::unordered_map<int, T> id_object_map_;
 
  /// @brief name to object ID map
  std::unordered_map<std::string, int> name_id_map_;
 
  /**
   * @brief Build the bank
   *
   * @param json_input JSON input
   */
  virtual void Build(const json& json_input) = 0;
};
}  // namespace hummingbird
 
#endif  // HUMMINGBIRD_BANKS_BANK_BASE_H_