Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
navigate_to_pose_action.hpp
1 // Copyright (c) 2018 Intel Corporation
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_TO_POSE_ACTION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__NAVIGATE_TO_POSE_ACTION_HPP_
17 
18 #include <string>
19 
20 #include "geometry_msgs/msg/point.hpp"
21 #include "geometry_msgs/msg/quaternion.hpp"
22 #include "nav2_msgs/action/navigate_to_pose.hpp"
23 #include "nav2_behavior_tree/bt_action_node.hpp"
24 #include "nav2_ros_common/lifecycle_node.hpp"
25 
26 namespace nav2_behavior_tree
27 {
28 
34 class NavigateToPoseAction : public BtActionNode<nav2_msgs::action::NavigateToPose>
35 {
36  using Action = nav2_msgs::action::NavigateToPose;
37  using ActionResult = Action::Result;
38 
39 public:
47  const std::string & xml_tag_name,
48  const std::string & action_name,
49  const BT::NodeConfiguration & conf);
50 
54  void on_tick() override;
55 
59  BT::NodeStatus on_success() override;
60 
64  BT::NodeStatus on_aborted() override;
65 
69  BT::NodeStatus on_cancelled() override;
70 
75  void on_timeout() override;
76 
81  static BT::PortsList providedPorts()
82  {
83  // Register JSON definitions for the types used in the ports
84  BT::RegisterJsonDefinition<geometry_msgs::msg::PoseStamped>();
85 
86  return providedBasicPorts(
87  {
88  BT::InputPort<geometry_msgs::msg::PoseStamped>("goal", "Destination to plan to"),
89  BT::InputPort<std::string>("behavior_tree", "Behavior tree to run"),
90  BT::OutputPort<ActionResult::_error_code_type>(
91  "error_code_id", "Navigate to pose error code"),
92  BT::OutputPort<std::string>(
93  "error_msg", "Navigate to pose error msg"),
94  });
95  }
96 };
97 
98 } // namespace nav2_behavior_tree
99 
100 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__NAVIGATE_TO_POSE_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::NavigateToPose.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
static BT::PortsList providedPorts()
Creates list of BT ports.
void on_timeout() override
Function to perform work in a BT Node when the action server times out Such as setting the error code...
NavigateToPoseAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::NavigateToPoseAction.
void on_tick() override
Function to perform some user-defined operation on tick.