Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
navigate_through_poses_action.cpp
1 // Copyright (c) 2021 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 #include <memory>
16 #include <string>
17 
18 #include "nav2_behavior_tree/plugins/action/navigate_through_poses_action.hpp"
19 
20 namespace nav2_behavior_tree
21 {
22 
24  const std::string & xml_tag_name,
25  const std::string & action_name,
26  const BT::NodeConfiguration & conf)
27 : BtActionNode<nav2_msgs::action::NavigateThroughPoses>(xml_tag_name, action_name, conf)
28 {
29 }
30 
32 {
33  if (!getInput("goals", goal_.poses)) {
34  RCLCPP_ERROR(
35  node_->get_logger(),
36  "NavigateThroughPosesAction: goal not provided");
37  return;
38  }
39  getInput("behavior_tree", goal_.behavior_tree);
40 }
41 
43 {
44  setOutput("error_code_id", ActionResult::NONE);
45  setOutput("error_msg", "");
46  return BT::NodeStatus::SUCCESS;
47 }
48 
50 {
51  setOutput("error_code_id", result_.result->error_code);
52  setOutput("error_msg", result_.result->error_msg);
53  return BT::NodeStatus::FAILURE;
54 }
55 
57 {
58  // Set empty error code, action was cancelled
59  setOutput("error_code_id", ActionResult::NONE);
60  setOutput("error_msg", "");
61  return BT::NodeStatus::SUCCESS;
62 }
63 
65 {
66  setOutput("error_code_id", ActionResult::TIMEOUT);
67  setOutput("error_msg", "Behavior Tree action client timed out waiting.");
68 }
69 
70 } // namespace nav2_behavior_tree
71 
72 #include "behaviortree_cpp/bt_factory.h"
73 BT_REGISTER_NODES(factory)
74 {
75  BT::NodeBuilder builder =
76  [](const std::string & name, const BT::NodeConfiguration & config)
77  {
78  return std::make_unique<nav2_behavior_tree::NavigateThroughPosesAction>(
79  name, "navigate_through_poses", config);
80  };
81 
82  factory.registerBuilder<nav2_behavior_tree::NavigateThroughPosesAction>(
83  "NavigateThroughPoses", builder);
84 }
Abstract class representing an action based BT node.
A nav2_behavior_tree::BtActionNode class that wraps nav2_msgs::action::NavigateThroughPoses.
void on_timeout() override
Function to perform work in a BT Node when the action server times out Such as setting the error code...
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
NavigateThroughPosesAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::NavigateThroughPosesAction.
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.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.