blackboard_key_info.hpp

Go to the documentation of this file.

// Copyright (C) 2026 Miguel Ángel González Santamarta
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef YASMIN__BLACKBOARD_KEY_INFO_HPP_
#define YASMIN__BLACKBOARD_KEY_INFO_HPP_
 
#include <functional>
#include <memory>
#include <string>
#include <type_traits>
#include <unordered_map>
#include <vector>
 
#include "yasmin/blackboard.hpp"
 
namespace yasmin {

struct BlackboardKeyInfo {
  std::string name;
  std::string description;
  bool has_default{false};
  std::shared_ptr<void> default_value{};
  std::string default_value_type{};
  std::function<void(Blackboard &, const std::string &)> inject_default{};

  BlackboardKeyInfo() = default;

  explicit BlackboardKeyInfo(std::string key_name)
      : name(std::move(key_name)) {}

  BlackboardKeyInfo(std::string key_name, std::string key_description)
      : name(std::move(key_name)), description(std::move(key_description)) {}

  template <typename T>
  BlackboardKeyInfo(std::string key_name, std::string key_description, T value)
      : name(std::move(key_name)), description(std::move(key_description)),
        has_default(true), default_value(std::make_shared<std::decay_t<T>>(
                               std::forward<T>(value))),
        default_value_type(demangle_type(typeid(std::decay_t<T>).name())) {
    using ValueType = std::decay_t<T>;
    auto stored = std::static_pointer_cast<ValueType>(this->default_value);
    inject_default = [stored](Blackboard &bb, const std::string &key) {
      bb.set<ValueType>(key, *stored);
    };
  }

  BlackboardKeyInfo(std::string key_name, std::string key_description,
                    const char *value)
      : name(std::move(key_name)), description(std::move(key_description)),
        has_default(true), default_value(std::make_shared<std::string>(value)),
        default_value_type(demangle_type(typeid(std::string).name())) {
    auto stored = std::static_pointer_cast<std::string>(this->default_value);
    inject_default = [stored](Blackboard &bb, const std::string &key) {
      bb.set<std::string>(key, *stored);
    };
  }

  template <typename T> T get_default_value() const {
    return *std::static_pointer_cast<T>(this->default_value);
  }
};

struct StateMetadata {
  std::string description;
  std::unordered_map<std::string, std::string> outcome_descriptions;
  std::vector<BlackboardKeyInfo> input_keys;
  std::vector<BlackboardKeyInfo> output_keys;
  std::vector<BlackboardKeyInfo> parameters;
};
 
} // namespace yasmin
 
#endif // YASMIN__BLACKBOARD_KEY_INFO_HPP_