simulation_setting_record.h

[詳解]

 
 
// Copyright(c) 2023-2025 Design Engineering Laboratory, Saitama University
// Released under the MIT license
// https://opensource.org/licenses/mit-license.php
 
#ifndef DESIGNLAB_SIMULATION_SETTING_RECORD_H_
#define DESIGNLAB_SIMULATION_SETTING_RECORD_H_
 
#include <format>
#include <string>
#include <vector>
 
#include "hexapod_next_move.h"
#include "math_euler.h"
#include "math_vector3.h"
#include "string_util.h"
#include "toml_serialize_macro.h"
 
namespace designlab::enums {
 
enum class MapCreateMode : int { kForSimulation, kFromFile };
 
enum class RobotOperateMode : int { kForGloabalPathGenerate, kFixed, kForPath };
 
enum class SimulationEndCheckMode : int {
  kGoalTape,  
  kPosture,   
  kPosition,  
};
 
}  // namespace designlab::enums
 
namespace designlab {
 
struct SimulationSettingRecord final {
  enums::MapCreateMode map_create_mode{enums::MapCreateMode::kForSimulation};
 
  std::string simulation_map_param_file_name{"simulation_map.toml"};
 
  std::string map_file_name{"map_state.csv"};
 
  enums::SimulationEndCheckMode end_check_mode{
      enums::SimulationEndCheckMode::kGoalTape};
 
  float goal_tape_position_x{1200.0f};
 
  EulerXYZ target_posture{0.f, 0.f, 0.f};
 
  float target_posture_allowable_error_deg{1.0f};
 
  Vector3 target_position{0.f, 0.f, 0.f};
 
  float target_position_allowable_error{50.0f};
 
  enums::RobotOperateMode operate_mode{enums::RobotOperateMode::kFixed};
 
  std::string fixed_operate_file_name{"robot_operator.toml"};
 
  std::vector<Vector3> path_points{{0, 0, 0}, {1000, 0, 0}};
 
  Vector3 initial_positions{0.f, 0.f, 30.f};
 
  EulerXYZ initial_posture{0.f, 0.f, 0.f};
 
  HexapodMove initial_move{HexapodMove::kComMove};
};
 
DESIGNLAB_TOML11_DESCRIPTION_CLASS(SimulationSettingRecord) {
  using enum enums::MapCreateMode;
  using enum enums::RobotOperateMode;
  using enum enums::SimulationEndCheckMode;
  using enum HexapodMove;
 
  DESIGNLAB_TOML11_FILE_ADD_DESCRIPTION(
      "シミュレーションを行う際の設定はこのファイルで設定します.");
 
  DESIGNLAB_TOML11_TABLE_ADD_DESCRIPTION(
      "Map", "マップについての設定です.", "EndChecker",
      "終了条件についての設定です.", "RobotOperator",
      "ロボットの操作方法の設定です.");
 
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      map_create_mode, "Map",
      std::format(
          "マップの作成方法を設定します.( \"{}\" )",
          string_util::EnumValuesToString<enums::MapCreateMode>("\" / \"")));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      simulation_map_param_file_name, "Map",
      std::format("マップの作成方法がシミュレーション専用マップを出力するモード"
                  " ( {} ) の場合,マップのパラメータを記述した toml "
                  "ファイルの名前を設定します.",
                  string_util::EnumToStringRemoveTopK(kForSimulation)));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      map_file_name, "Map",
      std::format("マップの作成方法がファイルから読み込むモード ( {} ) の場合,"
                  "マップの csvファイルの名前を設定します.",
                  string_util::EnumToStringRemoveTopK(kFromFile)));
 
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      end_check_mode, "EndChecker",
      std::format(
          "どのような方法で終了させるかを設定します.( \"{}\" )",
          string_util::EnumValuesToString<enums::SimulationEndCheckMode>(
              "\" / \"")));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      goal_tape_position_x, "EndChecker",
      std::format("終了条件がゴールテープに到達したか ( {} ) の場合,"
                  "ゴールテープのx座標を設定します.[mm]",
                  string_util::EnumToStringRemoveTopK(kGoalTape)));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      target_posture, "EndChecker",
      std::format("終了条件が目標姿勢となったか ( {} ) の場合,"
                  "目標の姿勢(xyzオイラー角)を設定します.[deg]",
                  string_util::EnumToStringRemoveTopK(kPosture)));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      target_posture_allowable_error_deg, "EndChecker",
      std::format("終了条件が目標姿勢となったか ( {} ) の場合,"
                  "目標の姿勢の角度の許容誤差を設定します.[deg]",
                  string_util::EnumToStringRemoveTopK(kPosture)));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      target_position, "EndChecker",
      std::format("終了条件が目的の座標に到達したか ( {} ) の場合,"
                  "目標の座標を設定します.[mm]",
                  string_util::EnumToStringRemoveTopK(kPosition)));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      target_position_allowable_error, "EndChecker",
      std::format("終了条件が目的の座標に到達したか ( {} ) の場合,"
                  "目標の座標の許容誤差を設定します.[mm]",
                  string_util::EnumToStringRemoveTopK(kPosition)));
 
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      operate_mode, "RobotOperator",
      std::format(
          "ロボットの操作方法を設定します.( \"{}\" )",
          string_util::EnumValuesToString<enums::RobotOperateMode>("\" / \"")));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      fixed_operate_file_name, "RobotOperator",
      std::format("ロボットの操作方法が固定 ( {} ) の場合,"
                  "その操作方法を指定するファイルを設定します.",
                  string_util::EnumToStringRemoveTopK(
                      enums::RobotOperateMode::kFixed)));
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      path_points, "RobotOperator",
      std::format(
          "ロボットの操作方法がパス ( {} ) の場合,そのパスを設定します.",
          string_util::EnumToStringRemoveTopK(kForPath)));
 
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      initial_positions, "Initial",
      "シミュレーション開始時のロボットの位置を設定します.[mm]."
      "地面にめり込んでいる場合には機能しないため,注意すること.");
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      initial_posture, "Initial",
      "シミュレーション開始時のロボットの姿勢を設定します.[deg]."
      "地面にめり込んでいる場合には機能しないため,注意すること.");
  DESIGNLAB_TOML11_VARIABLE_ADD_DESCRIPTION(
      initial_move, "Initial",
      std::format(
          "シミュレーション開始時のロボットの歩容を設定します.( \"{}\" )",
          string_util::EnumValuesToString<HexapodMove>("\" / \"")));
};
 
}  // namespace designlab
 
DESIGNLAB_TOML11_SERIALIZE(designlab::SimulationSettingRecord, map_create_mode,
                           simulation_map_param_file_name, map_file_name,
                           end_check_mode, goal_tape_position_x, target_posture,
                           target_posture_allowable_error_deg, target_position,
                           target_position_allowable_error, operate_mode,
                           fixed_operate_file_name, path_points,
                           initial_positions, initial_move, initial_posture);
 
#endif  // DESIGNLAB_SIMULATION_SETTING_RECORD_H_