feat(autoware_planning_factor_interface): move to core

planning/autoware_planning_factor_interface/CMakeLists.txt

@@ -0,0 +1,11 @@
+cmake_minimum_required(VERSION 3.14)
+project(autoware_planning_factor_interface)
+
+find_package(autoware_cmake REQUIRED)
+autoware_package()
+
+ament_auto_add_library(autoware_planning_factor_interface SHARED
+  DIRECTORY src
+)
+
+ament_auto_package()

planning/autoware_planning_factor_interface/README.md

@@ -0,0 +1,66 @@
+# autoware_planning_factor_interface
+
+## Overview
+
+The `PlanningFactorInterface` is a C++ class designed to facilitate the addition and publication of planning factors.
+
+## Design
+
+The `PlanningFactorInterface` class is designed to be lightweight and efficient, with the following key components:
+
+- **Add:** Methods to add planning factors to the interface.
+
+- **Publisher:** The class includes a publisher for `PlanningFactorArray` messages, which are used to distribute planning factors to other nodes in the system.
+
+The design emphasizes flexibility and ease of use, allowing developers to quickly integrate new planning factors into autoware.
+
+## Usage
+
+### Including the Header
+
+To use the `PlanningFactorInterface`, include the header file in your code:
+
+```cpp
+#include <autoware/planning_factor_interface/planning_factor_interface.hpp>
+```
+
+### Creating an Instance
+
+Instantiate the `PlanningFactorInterface` by providing a node and a name for the factor module:
+
+```cpp
+
+class PlannerInterface
+{
+public:
+  virtual ~PlannerInterface() = default;
+  PlannerInterface(
+    rclcpp::Node & node, const LongitudinalInfo & longitudinal_info,
+    const autoware::vehicle_info_utils::VehicleInfo & vehicle_info,
+    const EgoNearestParam & ego_nearest_param, const std::shared_ptr<DebugData> debug_data_ptr)
+  : planning_factor_interface_{std::make_unique<
+      autoware::planning_factor_interface::PlanningFactorInterface>(
+      &node, "obstacle_cruise_planner")},
+```
+
+code example from src/universe/autoware.universe/planning/autoware_obstacle_cruise_planner/include/autoware/obstacle_cruise_planner/planner_interface.hpp
+
+### Adding Planning Factors
+
+The `add` method can be used to add planning factors. Here's an example from src/universe/autoware.universe/planning/autoware_obstacle_cruise_planner/src/pid_based_planner/pid_based_planner.cpp.
+
+```cpp
+planning_factor_interface_->add(
+        stop_traj_points, planner_data.ego_pose, stop_traj_points.at(wall_idx).pose,
+        autoware_internal_planning_msgs::msg::PlanningFactor::NONE,
+        autoware_internal_planning_msgs::msg::SafetyFactorArray{});
+```
+
+### Publishing Factors
+
+After adding planning factors, you can publish them by calling the `publish` method:
+
+```cpp
+// Publish the added factors
+planning_factor_interface_->publish();
+```

planning/autoware_planning_factor_interface/include/autoware/planning_factor_interface/planning_factor_interface.hpp

@@ -0,0 +1,242 @@
+// Copyright 2024 TIER IV, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef AUTOWARE__PLANNING_FACTOR_INTERFACE__PLANNING_FACTOR_INTERFACE_HPP_
+#define AUTOWARE__PLANNING_FACTOR_INTERFACE__PLANNING_FACTOR_INTERFACE_HPP_
+
+#include <autoware/motion_utils/trajectory/trajectory.hpp>
+#include <rclcpp/rclcpp.hpp>
+
+#include <autoware_internal_planning_msgs/msg/control_point.hpp>
+#include <autoware_internal_planning_msgs/msg/path_point_with_lane_id.hpp>
+#include <autoware_internal_planning_msgs/msg/planning_factor.hpp>
+#include <autoware_internal_planning_msgs/msg/planning_factor_array.hpp>
+#include <autoware_internal_planning_msgs/msg/safety_factor_array.hpp>
+#include <autoware_planning_msgs/msg/path_point.hpp>
+#include <autoware_planning_msgs/msg/trajectory_point.hpp>
+#include <geometry_msgs/msg/pose.hpp>
+
+#include <string>
+#include <vector>
+
+namespace autoware::planning_factor_interface
+{
+
+using autoware_internal_planning_msgs::msg::ControlPoint;
+using autoware_internal_planning_msgs::msg::PlanningFactor;
+using autoware_internal_planning_msgs::msg::PlanningFactorArray;
+using autoware_internal_planning_msgs::msg::SafetyFactorArray;
+using geometry_msgs::msg::Pose;
+
+class PlanningFactorInterface
+{
+public:
+  PlanningFactorInterface(rclcpp::Node * node, const std::string & name)
+  : name_{name},
+    pub_factors_{
+      node->create_publisher<PlanningFactorArray>("/planning/planning_factors/" + name, 1)},
+    clock_{node->get_clock()}
+  {
+  }
+
+  /**
+   * @brief factor setter for single control point.
+   *
+   * @param path points.
+   * @param ego current pose.
+   * @param control point pose. (e.g. stop or slow down point pose)
+   * @param behavior of this planning factor.
+   * @param safety factor.
+   * @param driving direction.
+   * @param target velocity of the control point.
+   * @param shift length of the control point.
+   * @param detail information.
+   */
+  template <class PointType>
+  void add(
+    const std::vector<PointType> & points, const Pose & ego_pose, const Pose & control_point_pose,
+    const uint16_t behavior, const SafetyFactorArray & safety_factors,
+    const bool is_driving_forward = true, const double velocity = 0.0,
+    const double shift_length = 0.0, const std::string & detail = "")
+  {
+    const auto distance = static_cast<float>(autoware::motion_utils::calcSignedArcLength(
+      points, ego_pose.position, control_point_pose.position));
+    add(
+      distance, control_point_pose, behavior, safety_factors, is_driving_forward, velocity,
+      shift_length, detail);
+  }
+
+  /**
+   * @brief factor setter for two control points (section).
+   *
+   * @param path points.
+   * @param ego current pose.
+   * @param control section start pose. (e.g. lane change start point pose)
+   * @param control section end pose. (e.g. lane change end point pose)
+   * @param behavior of this planning factor.
+   * @param safety factor.
+   * @param driving direction.
+   * @param target velocity of the control point.
+   * @param shift length of the control point.
+   * @param detail information.
+   */
+  template <class PointType>
+  void add(
+    const std::vector<PointType> & points, const Pose & ego_pose, const Pose & start_pose,
+    const Pose & end_pose, const uint16_t behavior, const SafetyFactorArray & safety_factors,
+    const bool is_driving_forward = true, const double velocity = 0.0,
+    const double shift_length = 0.0, const std::string & detail = "")
+  {
+    const auto start_distance = static_cast<float>(
+      autoware::motion_utils::calcSignedArcLength(points, ego_pose.position, start_pose.position));
+    const auto end_distance = static_cast<float>(
+      autoware::motion_utils::calcSignedArcLength(points, ego_pose.position, end_pose.position));
+    add(
+      start_distance, end_distance, start_pose, end_pose, behavior, safety_factors,
+      is_driving_forward, velocity, shift_length, detail);
+  }
+
+  /**
+   * @brief factor setter for single control point.
+   *
+   * @param distance to control point.
+   * @param control point pose. (e.g. stop point pose)
+   * @param behavior of this planning factor.
+   * @param safety factor.
+   * @param driving direction.
+   * @param target velocity of the control point.
+   * @param shift length of the control point.
+   * @param detail information.
+   */
+  void add(
+    const double distance, const Pose & control_point_pose, const uint16_t behavior,
+    const SafetyFactorArray & safety_factors, const bool is_driving_forward = true,
+    const double velocity = 0.0, const double shift_length = 0.0, const std::string & detail = "")
+  {
+    const auto control_point = autoware_internal_planning_msgs::build<ControlPoint>()
+                                 .pose(control_point_pose)
+                                 .velocity(velocity)
+                                 .shift_length(shift_length)
+                                 .distance(distance);
+
+    const auto factor = autoware_internal_planning_msgs::build<PlanningFactor>()
+                          .module(name_)
+                          .is_driving_forward(is_driving_forward)
+                          .control_points({control_point})
+                          .behavior(behavior)
+                          .detail(detail)
+                          .safety_factors(safety_factors);
+
+    factors_.push_back(factor);
+  }
+
+  /**
+   * @brief factor setter for two control points (section).
+   *
+   * @param distance to control section start point.
+   * @param distance to control section end point.
+   * @param control section start pose. (e.g. lane change start point pose)
+   * @param control section end pose. (e.g. lane change end point pose)
+   * @param behavior of this planning factor.
+   * @param safety factor.
+   * @param driving direction.
+   * @param target velocity of the control point.
+   * @param shift length of the control point.
+   * @param detail information.
+   */
+  void add(
+    const double start_distance, const double end_distance, const Pose & start_pose,
+    const Pose & end_pose, const uint16_t behavior, const SafetyFactorArray & safety_factors,
+    const bool is_driving_forward = true, const double velocity = 0.0,
+    const double shift_length = 0.0, const std::string & detail = "")
+  {
+    const auto control_start_point = autoware_internal_planning_msgs::build<ControlPoint>()
+                                       .pose(start_pose)
+                                       .velocity(velocity)
+                                       .shift_length(shift_length)
+                                       .distance(start_distance);
+
+    const auto control_end_point = autoware_internal_planning_msgs::build<ControlPoint>()
+                                     .pose(end_pose)
+                                     .velocity(velocity)
+                                     .shift_length(shift_length)
+                                     .distance(end_distance);
+
+    const auto factor = autoware_internal_planning_msgs::build<PlanningFactor>()
+                          .module(name_)
+                          .is_driving_forward(is_driving_forward)
+                          .control_points({control_start_point, control_end_point})
+                          .behavior(behavior)
+                          .detail(detail)
+                          .safety_factors(safety_factors);
+
+    factors_.push_back(factor);
+  }
+
+  /**
+   * @brief publish planning factors.
+   */
+  void publish()
+  {
+    PlanningFactorArray msg;
+    msg.header.frame_id = "map";
+    msg.header.stamp = clock_->now();
+    msg.factors = factors_;
+
+    pub_factors_->publish(msg);
+
+    factors_.clear();
+  }
+
+private:
+  std::string name_;
+
+  rclcpp::Publisher<PlanningFactorArray>::SharedPtr pub_factors_;
+
+  rclcpp::Clock::SharedPtr clock_;
+
+  std::vector<PlanningFactor> factors_;
+};
+
+extern template void
+PlanningFactorInterface::add<autoware_internal_planning_msgs::msg::PathPointWithLaneId>(
+  const std::vector<autoware_internal_planning_msgs::msg::PathPointWithLaneId> &, const Pose &,
+  const Pose &, const uint16_t behavior, const SafetyFactorArray &, const bool, const double,
+  const double, const std::string &);
+extern template void PlanningFactorInterface::add<autoware_planning_msgs::msg::PathPoint>(
+  const std::vector<autoware_planning_msgs::msg::PathPoint> &, const Pose &, const Pose &,
+  const uint16_t behavior, const SafetyFactorArray &, const bool, const double, const double,
+  const std::string &);
+extern template void PlanningFactorInterface::add<autoware_planning_msgs::msg::TrajectoryPoint>(
+  const std::vector<autoware_planning_msgs::msg::TrajectoryPoint> &, const Pose &, const Pose &,
+  const uint16_t behavior, const SafetyFactorArray &, const bool, const double, const double,
+  const std::string &);
+
+extern template void
+PlanningFactorInterface::add<autoware_internal_planning_msgs::msg::PathPointWithLaneId>(
+  const std::vector<autoware_internal_planning_msgs::msg::PathPointWithLaneId> &, const Pose &,
+  const Pose &, const Pose &, const uint16_t behavior, const SafetyFactorArray &, const bool,
+  const double, const double, const std::string &);
+extern template void PlanningFactorInterface::add<autoware_planning_msgs::msg::PathPoint>(
+  const std::vector<autoware_planning_msgs::msg::PathPoint> &, const Pose &, const Pose &,
+  const Pose &, const uint16_t behavior, const SafetyFactorArray &, const bool, const double,
+  const double, const std::string &);
+extern template void PlanningFactorInterface::add<autoware_planning_msgs::msg::TrajectoryPoint>(
+  const std::vector<autoware_planning_msgs::msg::TrajectoryPoint> &, const Pose &, const Pose &,
+  const Pose &, const uint16_t behavior, const SafetyFactorArray &, const bool, const double,
+  const double, const std::string &);
+
+}  // namespace autoware::planning_factor_interface
+
+#endif  // AUTOWARE__PLANNING_FACTOR_INTERFACE__PLANNING_FACTOR_INTERFACE_HPP_

planning/autoware_planning_factor_interface/package.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
+<package format="3">
+  <name>autoware_planning_factor_interface</name>
+  <version>0.0.0</version>
+  <description>The autoware_planning_factor_interface package</description>
+  <maintainer email="satoshi.ota@tier4.jp">Satoshi Ota</maintainer>
+  <maintainer email="mamoru.sobue@tier4.jp">Mamoru Sobue</maintainer>
+  <license>Apache License 2.0</license>
+
+  <author email="satoshi.ota@tier4.jp">Satoshi Ota</author>
+
+  <buildtool_depend>ament_cmake_auto</buildtool_depend>
+  <buildtool_depend>autoware_cmake</buildtool_depend>
+
+  <depend>autoware_internal_planning_msgs</depend>
+  <depend>autoware_motion_utils</depend>
+  <depend>autoware_planning_msgs</depend>
+  <depend>autoware_utils</depend>
+  <depend>rclcpp</depend>
+
+  <test_depend>ament_cmake_ros</test_depend>
+  <test_depend>ament_lint_auto</test_depend>
+  <test_depend>autoware_lint_common</test_depend>
+
+  <export>
+    <build_type>ament_cmake</build_type>
+  </export>
+</package>