Nav2 Navigation Stack - jazzy  jazzy
ROS 2 Navigation Stack
compute_path_through_poses_action.hpp
1 // Copyright (c) 2021 Samsung Research America
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_PATH_THROUGH_POSES_ACTION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__COMPUTE_PATH_THROUGH_POSES_ACTION_HPP_
17 
18 #include <string>
19 #include <vector>
20 
21 #include "behaviortree_cpp/json_export.h"
22 #include "nav2_msgs/action/compute_path_through_poses.hpp"
23 #include "nav_msgs/msg/path.h"
24 #include "nav2_behavior_tree/bt_action_node.hpp"
25 
26 namespace nav2_behavior_tree
27 {
28 
29 
41  : public BtActionNode<nav2_msgs::action::ComputePathThroughPoses>
42 {
43  using Action = nav2_msgs::action::ComputePathThroughPoses;
44  using ActionResult = Action::Result;
45 
46 public:
54  const std::string & xml_tag_name,
55  const std::string & action_name,
56  const BT::NodeConfiguration & conf);
57 
61  void on_tick() override;
62 
66  BT::NodeStatus on_success() override;
67 
71  BT::NodeStatus on_aborted() override;
72 
76  BT::NodeStatus on_cancelled() override;
77 
82  static BT::PortsList providedPorts()
83  {
84  // Register JSON definitions for the types used in the ports
85  BT::RegisterJsonDefinition<nav_msgs::msg::Path>();
86  BT::RegisterJsonDefinition<geometry_msgs::msg::PoseStamped>();
87 
88  return providedBasicPorts(
89  {
90  BT::InputPort<std::vector<geometry_msgs::msg::PoseStamped>>(
91  "goals",
92  "Destinations to plan through"),
93  BT::InputPort<geometry_msgs::msg::PoseStamped>(
94  "start", "Start pose of the path if overriding current robot pose"),
95  BT::InputPort<std::string>(
96  "planner_id", "",
97  "Mapped name to the planner plugin type to use"),
98  BT::OutputPort<nav_msgs::msg::Path>("path", "Path created by ComputePathThroughPoses node"),
99  BT::OutputPort<ActionResult::_error_code_type>(
100  "error_code_id", "The compute path through poses error code"),
101  });
102  }
103 };
104 
105 } // namespace nav2_behavior_tree
106 
107 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__COMPUTE_PATH_THROUGH_POSES_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::ComputePathThroughPoses.
void on_tick() override
Function to perform some user-defined operation on tick.
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.
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancelation of the action.
ComputePathThroughPosesAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::ComputePathThroughPosesAction.