Nav2 Navigation Stack - lyrical  lyrical
ROS 2 Navigation Stack
goal_reached_condition.hpp
1 // Copyright (c) 2019 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__CONDITION__GOAL_REACHED_CONDITION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__CONDITION__GOAL_REACHED_CONDITION_HPP_
17 
18 #include <string>
19 #include <memory>
20 
21 #include "nav2_ros_common/lifecycle_node.hpp"
22 #include "behaviortree_cpp/condition_node.h"
23 #include "behaviortree_cpp/json_export.h"
24 #include "nav2_behavior_tree/bt_utils.hpp"
25 #include "nav2_behavior_tree/json_utils.hpp"
26 #include "nav2_ros_common/tf2_factories.hpp"
27 
28 
29 namespace nav2_behavior_tree
30 {
31 
42 class GoalReachedCondition : public BT::ConditionNode
43 {
44 public:
51  const std::string & condition_name,
52  const BT::NodeConfiguration & conf);
53 
54  GoalReachedCondition() = delete;
55 
59  ~GoalReachedCondition() override;
60 
65  BT::NodeStatus tick() override;
66 
70  void initialize();
71 
76  bool isGoalReached();
77 
82  static BT::PortsList providedPorts()
83  {
84  // Register JSON definitions for the types used in the ports
85  BT::RegisterJsonDefinition<geometry_msgs::msg::PoseStamped>();
86 
87  return {
88  BT::InputPort<geometry_msgs::msg::PoseStamped>("goal", "Destination"),
89  BT::InputPort<std::string>("robot_base_frame", "Robot base frame")
90  };
91  }
92 
93 protected:
97  void cleanup()
98  {}
99 
100 private:
101  nav2::LifecycleNode::SharedPtr node_;
102  nav2::TransformBuffer::SharedPtr tf_;
103 
104  double goal_reached_tol_;
105  double transform_tolerance_;
106  std::string robot_base_frame_;
107 };
108 
109 } // namespace nav2_behavior_tree
110 
111 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__CONDITION__GOAL_REACHED_CONDITION_HPP_
A BT::ConditionNode that returns SUCCESS when a specified goal is reached and FAILURE otherwise.
static BT::PortsList providedPorts()
Creates list of BT ports.
void initialize()
Function to read parameters and initialize class variables.
BT::NodeStatus tick() override
The main override required by a BT action.
~GoalReachedCondition() override
A destructor for nav2_behavior_tree::GoalReachedCondition.
bool isGoalReached()
Checks if the current robot pose lies within a given distance from the goal.