Nav2 Navigation Stack - lyrical  lyrical
ROS 2 Navigation Stack
compute_and_track_route_action.hpp
1 // Copyright (c) 2025 Open Navigation LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__COMPUTE_AND_TRACK_ROUTE_ACTION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__COMPUTE_AND_TRACK_ROUTE_ACTION_HPP_
17 
18 #include <string>
19 #include <memory>
20 
21 #include "nav2_msgs/action/compute_and_track_route.hpp"
22 #include "nav2_behavior_tree/bt_action_node.hpp"
23 #include "nav2_ros_common/lifecycle_node.hpp"
24 
25 namespace nav2_behavior_tree
26 {
27 
38 class ComputeAndTrackRouteAction : public BtActionNode<nav2_msgs::action::ComputeAndTrackRoute>
39 {
40  using Action = nav2_msgs::action::ComputeAndTrackRoute;
41  using ActionResult = Action::Result;
42 
43 public:
51  const std::string & xml_tag_name,
52  const std::string & action_name,
53  const BT::NodeConfiguration & conf);
54 
58  void on_tick() override;
59 
63  BT::NodeStatus on_success() override;
64 
68  BT::NodeStatus on_aborted() override;
69 
73  BT::NodeStatus on_cancelled() override;
74 
80  void on_wait_for_result(
81  std::shared_ptr<const Action::Feedback> feedback) override;
82 
87 
92  static BT::PortsList providedPorts()
93  {
94  return providedBasicPorts(
95  {
96  BT::InputPort<unsigned int>("start_id", "ID of the start node"),
97  BT::InputPort<unsigned int>("goal_id", "ID of the goal node"),
98  BT::InputPort<geometry_msgs::msg::PoseStamped>(
99  "start",
100  "Start pose of the path if overriding current robot pose and using poses over IDs"),
101  BT::InputPort<geometry_msgs::msg::PoseStamped>(
102  "goal", "Goal pose of the path if using poses over IDs"),
103  BT::InputPort<bool>(
104  "use_start", false,
105  "Whether to use the start pose or the robot's current pose"),
106  BT::InputPort<bool>(
107  "use_poses", false, "Whether to use poses or IDs for start and goal"),
108  BT::OutputPort<builtin_interfaces::msg::Duration>(
109  "execution_duration",
110  "Time taken to compute and track route"),
111  BT::OutputPort<uint16_t>(
112  "last_node_id",
113  "ID of the previous node"),
114  BT::OutputPort<uint16_t>(
115  "next_node_id",
116  "ID of the next node"),
117  BT::OutputPort<uint16_t>(
118  "current_edge_id",
119  "ID of current edge"),
120  BT::OutputPort<nav2_msgs::msg::Route>(
121  "route",
122  "List of RouteNodes to go from start to end"),
123  BT::OutputPort<nav_msgs::msg::Path>(
124  "path",
125  "Path created by ComputeAndTrackRoute node"),
126  BT::OutputPort<bool>(
127  "rerouted",
128  "Whether the plan has rerouted"),
129  });
130  }
131 
132 protected:
133  Action::Feedback feedback_;
134 };
135 
136 } // namespace nav2_behavior_tree
137 
138 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__COMPUTE_AND_TRACK_ROUTE_ACTION_HPP_
Abstract class representing an action based BT node.
static BT::PortsList providedBasicPorts(BT::PortsList addition)
Any subclass of BtActionNode that accepts parameters must provide a providedPorts method and call pro...
A nav2_behavior_tree::BtActionNode class that wraps nav2_msgs::action::ComputeAndTrackRoute.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
static BT::PortsList providedPorts()
Creates list of BT ports.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.
ComputeAndTrackRouteAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::ComputeAndTrackRouteAction.
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
void on_wait_for_result(std::shared_ptr< const Action::Feedback > feedback) override
Function to perform some user-defined operation after a timeout waiting for a result that hasn't been...
void on_tick() override
Function to perform some user-defined operation on tick.
void resetFeedbackAndOutputPorts()
Function to set all feedbacks and output ports to be null values.