refactor(behavior_velocity_template_module): prefix package and names…

…pace with autoware_ (#6639) Signed-off-by: Esteve Fernandez <[email protected]>
autowarefoundation · Jul 22, 2024 · 0d23fbd · 0d23fbd
1 parent 8dbea11
commit 0d23fbd
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 23 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -147,6 +147,7 @@ perception/traffic_light_occlusion_predictor/** [email protected] tao.zhon
 perception/traffic_light_visualization/** [email protected] [email protected]
 planning/autoware_behavior_path_external_request_lane_change_module/** [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]
 planning/autoware_behavior_velocity_planner/** [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]
+planning/autoware_behavior_velocity_template_module/** [email protected]
 planning/autoware_planning_test_manager/** [email protected] [email protected]
 planning/autoware_remaining_distance_time_calculator/** [email protected]
 planning/autoware_static_centerline_generator/** [email protected] [email protected]
@@ -173,7 +174,6 @@ planning/behavior_velocity_planner_common/** [email protected] isamu.taka
 planning/behavior_velocity_run_out_module/** [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]
 planning/behavior_velocity_speed_bump_module/** [email protected] [email protected] [email protected]
 planning/behavior_velocity_stop_line_module/** [email protected] [email protected] [email protected] [email protected]
-planning/behavior_velocity_template_module/** [email protected]
 planning/behavior_velocity_traffic_light_module/** [email protected] [email protected] [email protected] [email protected]
 planning/behavior_velocity_virtual_traffic_light_module/** [email protected] [email protected] [email protected]
 planning/behavior_velocity_walkway_module/** [email protected] [email protected] [email protected] [email protected]

diff --git a/planning/.pages b/planning/.pages
@@ -19,7 +19,7 @@ nav:
         - 'Start Planner': planning/behavior_path_start_planner_module
   - 'Behavior Velocity Planner':
     - 'About Behavior Velocity': planning/autoware_behavior_velocity_planner
-    - 'Template for Custom Module': planning/behavior_velocity_template_module
+    - 'Template for Custom Module': planning/autoware_behavior_velocity_template_module
     - 'Available Module':
         - 'Blind Spot': planning/behavior_velocity_blind_spot_module
         - 'Crosswalk': planning/behavior_velocity_crosswalk_module

diff --git a/planning/autoware_behavior_velocity_planner/package.xml b/planning/autoware_behavior_velocity_planner/package.xml
@@ -80,7 +80,7 @@
   <test_depend>behavior_velocity_traffic_light_module</test_depend>
   <test_depend>behavior_velocity_virtual_traffic_light_module</test_depend>
   <test_depend>behavior_velocity_walkway_module</test_depend>
-  <!--<test_depend>behavior_velocity_template_module</test_depend>-->
+  <!--<test_depend>autoware_behavior_velocity_template_module</test_depend>-->
 
   <member_of_group>rosidl_interface_packages</member_of_group>
 

diff --git a/...r_velocity_template_module/CMakeLists.txt → ...r_velocity_template_module/CMakeLists.txt b/...r_velocity_template_module/CMakeLists.txt → ...r_velocity_template_module/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.14)
-project(behavior_velocity_template_module)
+project(autoware_behavior_velocity_template_module)
 
 find_package(autoware_cmake REQUIRED)
 autoware_package()

diff --git a/...havior_velocity_template_module/README.md → ...havior_velocity_template_module/README.md b/...havior_velocity_template_module/README.md → ...havior_velocity_template_module/README.md
@@ -41,7 +41,7 @@ The managing of your modules is defined in manager.hpp and manager.cpp. The mana
 #### Constructor `TemplateModuleManager`
 
 - This is the constructor of the `TemplateModuleManager` class, and it takes an `rclcpp::Node` reference as a parameter.
-- It initializes a member variable `dummy_parameter` to 0.0.
+- It initializes a member variable `dummy_parameter_` to 0.0.
 
 #### `getModuleName()` Method
 

diff --git a/...emplate_module/config/template.param.yaml → ...emplate_module/config/template.param.yaml b/...emplate_module/config/template.param.yaml → ...emplate_module/config/template.param.yaml
diff --git a/...vior_velocity_template_module/package.xml → ...vior_velocity_template_module/package.xml b/...vior_velocity_template_module/package.xml → ...vior_velocity_template_module/package.xml
@@ -1,9 +1,9 @@
 <?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>behavior_velocity_template_module</name>
+  <name>autoware_behavior_velocity_template_module</name>
   <version>0.1.0</version>
-  <description>The behavior_velocity_template_module package</description>
+  <description>The autoware_behavior_velocity_template_module package</description>
 
   <maintainer email="[email protected]">Daniel Sanchez</maintainer>
 

diff --git a/planning/autoware_behavior_velocity_template_module/plugins.xml b/planning/autoware_behavior_velocity_template_module/plugins.xml
@@ -0,0 +1,3 @@
+<library path="autoware_behavior_velocity_template_module">
+  <class type="autoware::behavior_velocity_planner::TemplateModulePlugin" base_class_type="autoware::behavior_velocity_planner::PluginInterface"/>
+</library>
diff --git a/..._velocity_template_module/src/manager.cpp → ..._velocity_template_module/src/manager.cpp b/..._velocity_template_module/src/manager.cpp → ..._velocity_template_module/src/manager.cpp
@@ -26,15 +26,15 @@
 #include <utility>
 #include <vector>
 
-namespace behavior_velocity_planner
+namespace autoware::behavior_velocity_planner
 {
 using tier4_autoware_utils::getOrDeclareParameter;
 
 TemplateModuleManager::TemplateModuleManager(rclcpp::Node & node)
 : SceneModuleManagerInterface(node, getModuleName())
 {
   std::string ns(getModuleName());
-  dummy_parameter = getOrDeclareParameter<double>(node, ns + ".dummy");
+  dummy_parameter_ = getOrDeclareParameter<double>(node, ns + ".dummy");
 }
 
 void TemplateModuleManager::launchNewModules(
@@ -56,8 +56,9 @@ TemplateModuleManager::getModuleExpiredFunction(
   };
 }
 
-}  // namespace behavior_velocity_planner
+}  // namespace autoware::behavior_velocity_planner
 
 #include <pluginlib/class_list_macros.hpp>
 PLUGINLIB_EXPORT_CLASS(
-  behavior_velocity_planner::TemplateModulePlugin, behavior_velocity_planner::PluginInterface)
+  autoware::behavior_velocity_planner::TemplateModulePlugin,
+  behavior_velocity_planner::PluginInterface)
diff --git a/..._velocity_template_module/src/manager.hpp → ..._velocity_template_module/src/manager.hpp b/..._velocity_template_module/src/manager.hpp → ..._velocity_template_module/src/manager.hpp
@@ -27,7 +27,7 @@
 #include <functional>
 #include <memory>
 
-namespace behavior_velocity_planner
+namespace autoware::behavior_velocity_planner
 {
 /**
  * @brief Constructor for the TemplateModuleManager class.
@@ -37,7 +37,7 @@ namespace behavior_velocity_planner
  *
  * @param node A reference to the ROS node.
  */
-class TemplateModuleManager : public SceneModuleManagerInterface
+class TemplateModuleManager : public ::behavior_velocity_planner::SceneModuleManagerInterface
 {
 public:
   explicit TemplateModuleManager(rclcpp::Node & node);
@@ -53,7 +53,7 @@ class TemplateModuleManager : public SceneModuleManagerInterface
   const char * getModuleName() override { return "template"; }
 
 private:
-  double dummy_parameter{0.0};
+  double dummy_parameter_{0.0};
 
   /**
    * @brief Launch new modules based on the provided path.
@@ -84,10 +84,11 @@ class TemplateModuleManager : public SceneModuleManagerInterface
  * The TemplateModulePlugin class is used to integrate the TemplateModuleManager into the Behavior
  * Velocity Planner.
  */
-class TemplateModulePlugin : public PluginWrapper<TemplateModuleManager>
+class TemplateModulePlugin
+: public ::behavior_velocity_planner::PluginWrapper<TemplateModuleManager>
 {
 };
 
-}  // namespace behavior_velocity_planner
+}  // namespace autoware::behavior_velocity_planner
 
 #endif  // MANAGER_HPP_
diff --git a/...or_velocity_template_module/src/scene.cpp → ...or_velocity_template_module/src/scene.cpp b/...or_velocity_template_module/src/scene.cpp → ...or_velocity_template_module/src/scene.cpp
@@ -21,7 +21,7 @@
 
 #include <string>
 
-namespace behavior_velocity_planner
+namespace autoware::behavior_velocity_planner
 {
 
 TemplateModule::TemplateModule(
@@ -49,4 +49,4 @@ bool TemplateModule::modifyPathVelocity(
   return false;
 }
 
-}  // namespace behavior_velocity_planner
+}  // namespace autoware::behavior_velocity_planner
diff --git a/...or_velocity_template_module/src/scene.hpp → ...or_velocity_template_module/src/scene.hpp b/...or_velocity_template_module/src/scene.hpp → ...or_velocity_template_module/src/scene.hpp
@@ -21,9 +21,11 @@
 #include <utility>
 #include <vector>
 
-namespace behavior_velocity_planner
+namespace autoware::behavior_velocity_planner
 {
 using autoware_auto_planning_msgs::msg::PathWithLaneId;
+using ::behavior_velocity_planner::SceneModuleInterface;
+using ::behavior_velocity_planner::StopReason;
 
 class TemplateModule : public SceneModuleInterface
 {
@@ -64,6 +66,6 @@ class TemplateModule : public SceneModuleInterface
   motion_utils::VirtualWalls createVirtualWalls() override;
 };
 
-}  // namespace behavior_velocity_planner
+}  // namespace autoware::behavior_velocity_planner
 
 #endif  // SCENE_HPP_
diff --git a/planning/behavior_velocity_template_module/plugins.xml b/planning/behavior_velocity_template_module/plugins.xml