Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
wait_action.hpp
1 // Copyright (c) 2018 Samsung Research America
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__WAIT_ACTION_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__WAIT_ACTION_HPP_
17 
18 #include <string>
19 
20 #include "nav2_behavior_tree/bt_action_node.hpp"
21 #include "nav2_msgs/action/wait.hpp"
22 #include "nav2_ros_common/lifecycle_node.hpp"
23 
24 namespace nav2_behavior_tree
25 {
26 
32 class WaitAction : public BtActionNode<nav2_msgs::action::Wait>
33 {
34  using Action = nav2_msgs::action::Wait;
35  using ActionResult = Action::Result;
36 
37 public:
44  WaitAction(
45  const std::string & xml_tag_name,
46  const std::string & action_name,
47  const BT::NodeConfiguration & conf);
48 
52  void on_tick() override;
53 
58  void on_timeout() override;
59 
63  void initialize();
64 
69  static BT::PortsList providedPorts()
70  {
71  return providedBasicPorts(
72  {
73  BT::InputPort<double>("wait_duration", 1.0, "Wait time"),
74  BT::OutputPort<ActionResult::_error_code_type>(
75  "error_code_id", "The wait behavior error code"),
76  BT::OutputPort<std::string>(
77  "error_msg", "The wait behavior error msg"),
78  });
79  }
80 
84  BT::NodeStatus on_success() override;
85 
89  BT::NodeStatus on_aborted() override;
90 
94  BT::NodeStatus on_cancelled() override;
95 };
96 
97 } // namespace nav2_behavior_tree
98 
99 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__WAIT_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::Wait.
Definition: wait_action.hpp:33
WaitAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::WaitAction.
Definition: wait_action.cpp:24
static BT::PortsList providedPorts()
Creates list of BT ports.
Definition: wait_action.hpp:69
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.
Definition: wait_action.cpp:62
void on_tick() override
Function to perform some user-defined operation on tick.
Definition: wait_action.cpp:46
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
Definition: wait_action.cpp:55
void initialize()
Function to read parameters and initialize class variables.
Definition: wait_action.cpp:32
void on_timeout() override
Function to perform work in a BT Node when the action server times out Such as setting the error code...
Definition: wait_action.cpp:76
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
Definition: wait_action.cpp:69