Nav2 Navigation Stack - humble  humble
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 public:
40  const std::string & xml_tag_name,
41  const std::string & action_name,
42  const BT::NodeConfiguration & conf);
43 
47  void on_tick() override;
48 
54  void on_wait_for_result(
55  std::shared_ptr<const nav2_msgs::action::FollowPath::Feedback> feedback) override;
56 
61  static BT::PortsList providedPorts()
62  {
63  return providedBasicPorts(
64  {
65  BT::InputPort<nav_msgs::msg::Path>("path", "Path to follow"),
66  BT::InputPort<std::string>("controller_id", ""),
67  BT::InputPort<std::string>("goal_checker_id", ""),
68  });
69  }
70 };
71 
72 } // namespace nav2_behavior_tree
73 
74 #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.
FollowPathAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::FollowPathAction.
void on_wait_for_result(std::shared_ptr< const nav2_msgs::action::FollowPath::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.