Skip to content

Commit

Permalink
refactor(operation_mode_transition_manager): prefix package and names…
Browse files Browse the repository at this point in the history
…pace with autoware_ (#7291)

* RT1-6682 add prefix package and namespace with autoware_

Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>

* RT1-6682 fix package's description

Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>

---------

Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
  • Loading branch information
zulfaqar-azmi-t4 authored Jun 11, 2024
1 parent 02e49bb commit dcf6b81
Show file tree
Hide file tree
Showing 19 changed files with 50 additions and 46 deletions.
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
cmake_minimum_required(VERSION 3.14)
project(operation_mode_transition_manager)
project(autoware_operation_mode_transition_manager)

find_package(autoware_cmake REQUIRED)
autoware_package()
find_package(ament_cmake_auto REQUIRED)
ament_auto_find_build_dependencies()

ament_auto_add_library(operation_mode_transition_manager_node SHARED
ament_auto_add_library(autoware_operation_mode_transition_manager_node SHARED
src/compatibility.cpp
src/data.cpp
src/node.cpp
src/state.cpp
)

rclcpp_components_register_node(operation_mode_transition_manager_node
PLUGIN "operation_mode_transition_manager::OperationModeTransitionManager"
EXECUTABLE operation_mode_transition_manager_exe
rclcpp_components_register_node(autoware_operation_mode_transition_manager_node
PLUGIN "autoware::operation_mode_transition_manager::OperationModeTransitionManager"
EXECUTABLE autoware_operation_mode_transition_manager_exe
)

rosidl_generate_interfaces(
Expand All @@ -26,12 +26,12 @@ rosidl_generate_interfaces(

# to use same package defined message
if(${rosidl_cmake_VERSION} VERSION_LESS 2.5.0)
rosidl_target_interfaces(operation_mode_transition_manager_node
rosidl_target_interfaces(autoware_operation_mode_transition_manager_node
${PROJECT_NAME} "rosidl_typesupport_cpp")
else()
rosidl_get_typesupport_target(
cpp_typesupport_target ${PROJECT_NAME} "rosidl_typesupport_cpp")
target_link_libraries(operation_mode_transition_manager_node "${cpp_typesupport_target}")
target_link_libraries(autoware_operation_mode_transition_manager_node "${cpp_typesupport_target}")
endif()


Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# operation_mode_transition_manager
# autoware_operation_mode_transition_manager

## Purpose / Use cases

Expand All @@ -25,15 +25,15 @@ There is also an `In Transition` state that occurs during each mode transitions.

## Design

A rough design of the relationship between `operation_mode_transition_manager`` and the other nodes is shown below.
A rough design of the relationship between `autoware_operation_mode_transition_manager`` and the other nodes is shown below.

![transition_rough_structure](image/transition_rough_structure.drawio.svg)

A more detailed structure is below.

![transition_detailed_structure](image/transition_detailed_structure.drawio.svg)

Here we see that `operation_mode_transition_manager` has multiple state transitions as follows
Here we see that `autoware_operation_mode_transition_manager` has multiple state transitions as follows

- **AUTOWARE ENABLED <---> DISABLED**
- **ENABLED**: the vehicle is controlled by Autoware.
Expand Down Expand Up @@ -73,7 +73,7 @@ For the backward compatibility (to be removed):
### Outputs

- /system/operation_mode/state [`autoware_adapi_v1_msgs/msg/OperationModeState`]: to inform the current operation mode
- /control/operation_mode_transition_manager/debug_info [`operation_mode_transition_manager/msg/OperationModeTransitionManagerDebug`]: detailed information about the operation mode transition
- /control/autoware_operation_mode_transition_manager/debug_info [`autoware_operation_mode_transition_manager/msg/OperationModeTransitionManagerDebug`]: detailed information about the operation mode transition

- /control/gate_mode_cmd [`tier4_control_msgs/msg/GateMode`]: to change the `vehicle_cmd_gate` state to use its features (to be removed)
- /autoware/engage [`autoware_vehicle_msgs/msg/Engage`]:
Expand All @@ -83,7 +83,7 @@ For the backward compatibility (to be removed):

## Parameters

{{ json_to_markdown("control/operation_mode_transition_manager/schema/operation_mode_transition_manager.schema.json") }}
{{ json_to_markdown("control/autoware_operation_mode_transition_manager/schema/operation_mode_transition_manager.schema.json") }}

| Name | Type | Description | Default value |
| :--------------------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------ |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<launch>
<arg name="operation_mode_transition_manager_param" default="$(find-pkg-share operation_mode_transition_manager)/config/operation_mode_transition_manager.param.yaml"/>
<arg name="operation_mode_transition_manager_param" default="$(find-pkg-share autoware_operation_mode_transition_manager)/config/operation_mode_transition_manager.param.yaml"/>
<arg name="vehicle_info_param_file" default="$(find-pkg-share autoware_vehicle_info_utils)/config/vehicle_info.param.yaml"/>

<!-- operation_mode_transition_manager -->
<node pkg="operation_mode_transition_manager" exec="operation_mode_transition_manager_exe" name="operation_mode_transition_manager" output="screen">
<!-- autoware_operation_mode_transition_manager -->
<node pkg="autoware_operation_mode_transition_manager" exec="autoware_operation_mode_transition_manager_exe" name="autoware_operation_mode_transition_manager" output="screen">
<!-- args -->
<param from="$(var vehicle_info_param_file)"/>
<param from="$(var operation_mode_transition_manager_param)"/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<package format="3">
<name>operation_mode_transition_manager</name>
<name>autoware_operation_mode_transition_manager</name>
<version>0.1.0</version>
<description>The vehicle_cmd_gate package</description>
<description>The operation_mode_transition_manager package</description>
<maintainer email="takamasa.horibe@tier4.jp">Takamasa Horibe</maintainer>
<maintainer email="tomoya.kimura@tier4.jp">Tomoya Kimura</maintainer>
<maintainer email="takayuki.murooka@tier4.jp">Takayuki Murooka</maintainer>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

#include <memory>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

Compatibility::Compatibility(rclcpp::Node * node) : node_(node)
Expand Down Expand Up @@ -140,4 +140,4 @@ void Compatibility::set_mode(const OperationMode mode)
}
}

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#include <tier4_control_msgs/msg/gate_mode.hpp>
#include <tier4_control_msgs/srv/external_command_select.hpp>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

class Compatibility
Expand Down Expand Up @@ -54,6 +54,6 @@ class Compatibility
SelectorModeMsg::ConstSharedPtr selector_mode_;
};

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager

#endif // COMPATIBILITY_HPP_
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#include "data.hpp"

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

std::string toString(const std::optional<OperationMode> mode)
Expand Down Expand Up @@ -67,4 +67,4 @@ OperationModeValue toMsg(const OperationMode mode)
return OperationModeState::UNKNOWN;
}

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
#include <optional>
#include <string>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

using ServiceResponse = autoware_adapi_v1_msgs::srv::ChangeOperationMode::Response;
Expand Down Expand Up @@ -81,6 +81,6 @@ std::string toString(const std::optional<OperationMode> mode);
std::optional<OperationMode> toEnum(const ChangeOperationMode::Request & request);
OperationModeValue toMsg(const OperationMode mode);

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager

#endif // DATA_HPP_
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@

#include <component_interface_utils/rclcpp/exceptions.hpp>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

OperationModeTransitionManager::OperationModeTransitionManager(const rclcpp::NodeOptions & options)
: Node("operation_mode_transition_manager", options), compatibility_(this)
: Node("autoware_operation_mode_transition_manager", options), compatibility_(this)
{
cli_control_mode_ = create_client<ControlModeCommand>("control_mode_request");
pub_debug_info_ = create_publisher<ModeChangeBase::DebugInfo>("~/debug_info", 1);
Expand Down Expand Up @@ -281,7 +281,8 @@ void OperationModeTransitionManager::publishData()
pub_debug_info_->publish(debug_info);
}

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager

#include <rclcpp_components/register_node_macro.hpp>
RCLCPP_COMPONENTS_REGISTER_NODE(operation_mode_transition_manager::OperationModeTransitionManager)
RCLCPP_COMPONENTS_REGISTER_NODE(
autoware::operation_mode_transition_manager::OperationModeTransitionManager)
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
#include <memory>
#include <unordered_map>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

class OperationModeTransitionManager : public rclcpp::Node
Expand Down Expand Up @@ -78,6 +78,6 @@ class OperationModeTransitionManager : public rclcpp::Node
std::optional<rclcpp::Time> compatibility_transition_;
};

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager

#endif // NODE_HPP_
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include <algorithm>
#include <cmath>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

using motion_utils::findNearestIndex;
Expand Down Expand Up @@ -316,4 +316,4 @@ bool AutonomousMode::isModeChangeAvailable()
return is_all_ok;
}

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
#ifndef STATE_HPP_
#define STATE_HPP_

#include "autoware_operation_mode_transition_manager/msg/operation_mode_transition_manager_debug.hpp"
#include "data.hpp"
#include "operation_mode_transition_manager/msg/operation_mode_transition_manager_debug.hpp"

#include <autoware_vehicle_info_utils/vehicle_info_utils.hpp>
#include <rclcpp/rclcpp.hpp>
Expand All @@ -28,7 +28,7 @@
#include <memory>
#include <utility>

namespace operation_mode_transition_manager
namespace autoware::operation_mode_transition_manager
{

class ModeChangeBase
Expand All @@ -39,7 +39,8 @@ class ModeChangeBase
virtual bool isModeChangeCompleted() = 0;
virtual bool isModeChangeAvailable() = 0;

using DebugInfo = operation_mode_transition_manager::msg::OperationModeTransitionManagerDebug;
using DebugInfo =
autoware_operation_mode_transition_manager::msg::OperationModeTransitionManagerDebug;
virtual DebugInfo getDebugInfo() { return DebugInfo{}; }
};

Expand Down Expand Up @@ -105,6 +106,6 @@ class RemoteMode : public ModeChangeBase
bool isModeChangeAvailable() override { return true; }
};

} // namespace operation_mode_transition_manager
} // namespace autoware::operation_mode_transition_manager

#endif // STATE_HPP_
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@
#ifndef UTIL_HPP_
#define UTIL_HPP_

#include "operation_mode_transition_manager/msg/operation_mode_transition_manager_debug.hpp"
#include "autoware_operation_mode_transition_manager/msg/operation_mode_transition_manager_debug.hpp"

using DebugInfo = operation_mode_transition_manager::msg::OperationModeTransitionManagerDebug;
using DebugInfo =
autoware_operation_mode_transition_manager::msg::OperationModeTransitionManagerDebug;

void setAllOk(DebugInfo & debug_info)
{
Expand Down
15 changes: 8 additions & 7 deletions launch/tier4_control_launch/launch/control.launch.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ def launch_setup(context, *args, **kwargs):
with open(LaunchConfiguration("control_validator_param_path").perform(context), "r") as f:
control_validator_param = yaml.safe_load(f)["/**"]["ros__parameters"]
with open(
LaunchConfiguration("operation_mode_transition_manager_param_path").perform(context), "r"
LaunchConfiguration("operation_mode_transition_manager_param_path").perform(context),
"r",
) as f:
operation_mode_transition_manager_param = yaml.safe_load(f)["/**"]["ros__parameters"]
with open(LaunchConfiguration("shift_decider_param_path").perform(context), "r") as f:
Expand Down Expand Up @@ -245,10 +246,10 @@ def launch_setup(context, *args, **kwargs):
)

# operation mode transition manager
operation_mode_transition_manager_component = ComposableNode(
package="operation_mode_transition_manager",
plugin="operation_mode_transition_manager::OperationModeTransitionManager",
name="operation_mode_transition_manager",
autoware_operation_mode_transition_manager_component = ComposableNode(
package="autoware_operation_mode_transition_manager",
plugin="autoware::operation_mode_transition_manager::OperationModeTransitionManager",
name="autoware_operation_mode_transition_manager",
remappings=[
# input
("kinematics", "/localization/kinematic_state"),
Expand Down Expand Up @@ -347,7 +348,7 @@ def launch_setup(context, *args, **kwargs):
lane_departure_component,
shift_decider_component,
vehicle_cmd_gate_component,
operation_mode_transition_manager_component,
autoware_operation_mode_transition_manager_component,
glog_component,
],
)
Expand All @@ -362,7 +363,7 @@ def launch_setup(context, *args, **kwargs):
lane_departure_component,
shift_decider_component,
vehicle_cmd_gate_component,
operation_mode_transition_manager_component,
autoware_operation_mode_transition_manager_component,
glog_component,
],
)
Expand Down

0 comments on commit dcf6b81

Please sign in to comment.