Nav2 Navigation Stack - jazzy  jazzy
ROS 2 Navigation Stack
navigate_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__NAVIGATE_THROUGH_POSES_ACTION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__NAVIGATE_THROUGH_POSES_ACTION_HPP_
17 
18 #include <string>
19 #include <vector>
20 
21 #include "geometry_msgs/msg/point.hpp"
22 #include "geometry_msgs/msg/quaternion.hpp"
23 #include "nav2_msgs/action/navigate_through_poses.hpp"
24 #include "nav2_behavior_tree/bt_action_node.hpp"
25 
26 namespace nav2_behavior_tree
27 {
28 
32 class NavigateThroughPosesAction : public BtActionNode<nav2_msgs::action::NavigateThroughPoses>
33 {
34  using Action = nav2_msgs::action::NavigateThroughPoses;
35  using ActionResult = Action::Result;
36 
37 public:
45  const std::string & xml_tag_name,
46  const std::string & action_name,
47  const BT::NodeConfiguration & conf);
48 
52  void on_tick() override;
53 
57  BT::NodeStatus on_success() override;
58 
62  BT::NodeStatus on_aborted() override;
63 
67  BT::NodeStatus on_cancelled() override;
68 
73  static BT::PortsList providedPorts()
74  {
75  return providedBasicPorts(
76  {
77  BT::InputPort<std::vector<geometry_msgs::msg::PoseStamped>>(
78  "goals", "Destinations to plan through"),
79  BT::InputPort<std::string>("behavior_tree", "Behavior tree to run"),
80  BT::OutputPort<ActionResult::_error_code_type>(
81  "error_code_id", "The navigate through poses error code"),
82  });
83  }
84 };
85 
86 } // namespace nav2_behavior_tree
87 
88 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__NAVIGATE_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::NavigateThroughPoses.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
NavigateThroughPosesAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::NavigateThroughPosesAction.
static BT::PortsList providedPorts()
Creates list of BT ports.
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
void on_tick() override
Function to perform some user-defined operation on tick.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.