Nav2 Navigation Stack - lyrical  lyrical
ROS 2 Navigation Stack
path_expiring_timer_condition.hpp
1 // Copyright (c) 2022 Joshua Wallace
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__PATH_EXPIRING_TIMER_CONDITION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__CONDITION__PATH_EXPIRING_TIMER_CONDITION_HPP_
17 
18 #include <string>
19 
20 #include "nav2_ros_common/lifecycle_node.hpp"
21 #include "behaviortree_cpp/condition_node.h"
22 #include "behaviortree_cpp/json_export.h"
23 #include "nav_msgs/msg/path.hpp"
24 #include "nav2_behavior_tree/bt_utils.hpp"
25 #include "nav2_behavior_tree/json_utils.hpp"
26 
27 namespace nav2_behavior_tree
28 {
29 
39 class PathExpiringTimerCondition : public BT::ConditionNode
40 {
41 public:
48  const std::string & condition_name,
49  const BT::NodeConfiguration & conf);
50 
51  PathExpiringTimerCondition() = delete;
52 
57  BT::NodeStatus tick() override;
58 
63  static BT::PortsList providedPorts()
64  {
65  // Register JSON definitions for the types used in the ports
66  BT::RegisterJsonDefinition<nav_msgs::msg::Path>();
67 
68  return {
69  BT::InputPort<double>("seconds", 1.0, "Seconds"),
70  BT::InputPort<nav_msgs::msg::Path>("path")
71  };
72  }
73 
74 private:
75  nav2::LifecycleNode::SharedPtr node_;
76  rclcpp::Time start_;
77  nav_msgs::msg::Path prev_path_;
78  double period_;
79  bool first_time_;
80 };
81 
82 } // namespace nav2_behavior_tree
83 
84 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__CONDITION__PATH_EXPIRING_TIMER_CONDITION_HPP_
A BT::ConditionNode that returns SUCCESS every time a specified time period passes and FAILURE otherw...
static BT::PortsList providedPorts()
Creates list of BT ports.
BT::NodeStatus tick() override
The main override required by a BT action.