Nav2 Navigation Stack - jazzy  jazzy
ROS 2 Navigation Stack
undock_robot.hpp
1 // Copyright (c) 2024 Open Navigation LLC
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 OPENNAV_DOCKING_BT__UNDOCK_ROBOT_HPP_
16 #define OPENNAV_DOCKING_BT__UNDOCK_ROBOT_HPP_
17 
18 #include <string>
19 #include <memory>
20 #include <vector>
21 
22 #include "nav2_msgs/action/undock_robot.hpp"
23 #include "geometry_msgs/msg/pose_stamped.hpp"
24 #include "nav2_behavior_tree/bt_action_node.hpp"
25 
26 namespace opennav_docking_bt
27 {
28 
34  nav2_msgs::action::UndockRobot>
35 {
36  using Action = nav2_msgs::action::UndockRobot;
37  using ActionResult = Action::Result;
38 
39 public:
47  const std::string & xml_tag_name,
48  const std::string & action_name,
49  const BT::NodeConfiguration & conf);
50 
54  void on_tick() override;
55 
59  BT::NodeStatus on_success() override;
60 
64  BT::NodeStatus on_aborted() override;
65 
69  BT::NodeStatus on_cancelled() override;
70 
74  void halt() override;
75 
80  static BT::PortsList providedPorts()
81  {
82  return providedBasicPorts(
83  {
84  BT::InputPort<std::string>(
85  "dock_type", "The dock plugin type, if not previous instance used for docking"),
86  BT::InputPort<float>(
87  "max_undocking_time", 30.0, "Maximum time to get back to the staging pose"),
88 
89  BT::OutputPort<ActionResult::_success_type>(
90  "success", "If the action was successful"),
91  BT::OutputPort<ActionResult::_error_code_type>(
92  "error_code_id", "Error code"),
93  });
94  }
95 };
96 
97 } // namespace opennav_docking_bt
98 
99 #endif // OPENNAV_DOCKING_BT__UNDOCK_ROBOT_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...
nav2_behavior_tree::BtActionNode class that wraps nav2_msgs/UndockRobot
static BT::PortsList providedPorts()
Creates list of BT ports.
BT::NodeStatus on_success() override
Function to perform some user-defined operation upon successful completion of the action.
void on_tick() override
Function to perform some user-defined operation on tick.
void halt() override
Override required by the a BT action. Cancel the action and set the path output.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.
UndockRobotAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for opennav_docking_bt::UndockRobotAction.