Nav2 Navigation Stack - jazzy  jazzy
ROS 2 Navigation Stack
follow_path_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__FOLLOW_PATH_ACTION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__FOLLOW_PATH_ACTION_HPP_
17 
18 #include <string>
19 #include <memory>
20 
21 #include "nav2_msgs/action/follow_path.hpp"
22 #include "nav2_behavior_tree/bt_action_node.hpp"
23 
24 namespace nav2_behavior_tree
25 {
26 
30 class FollowPathAction : public BtActionNode<nav2_msgs::action::FollowPath>
31 {
32  using Action = nav2_msgs::action::FollowPath;
33  using ActionResult = Action::Result;
34 
35 public:
43  const std::string & xml_tag_name,
44  const std::string & action_name,
45  const BT::NodeConfiguration & conf);
46 
50  void on_tick() override;
51 
55  BT::NodeStatus on_success() override;
56 
60  BT::NodeStatus on_aborted() override;
61 
65  BT::NodeStatus on_cancelled() override;
66 
72  void on_wait_for_result(
73  std::shared_ptr<const Action::Feedback> feedback) override;
74 
79  static BT::PortsList providedPorts()
80  {
81  return providedBasicPorts(
82  {
83  BT::InputPort<nav_msgs::msg::Path>("path", "Path to follow"),
84  BT::InputPort<std::string>("controller_id", ""),
85  BT::InputPort<std::string>("goal_checker_id", ""),
86  BT::InputPort<std::string>("progress_checker_id", ""),
87  BT::OutputPort<ActionResult::_error_code_type>(
88  "error_code_id", "The follow path error code"),
89  });
90  }
91 };
92 
93 } // namespace nav2_behavior_tree
94 
95 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__FOLLOW_PATH_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::FollowPath.
void on_tick() override
Function to perform some user-defined operation on tick.
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
FollowPathAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::FollowPathAction.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion 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...
static BT::PortsList providedPorts()
Creates list of BT ports.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.