Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
assisted_teleop_action.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 
16 #ifndef NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__ASSISTED_TELEOP_ACTION_HPP_
17 #define NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__ASSISTED_TELEOP_ACTION_HPP_
18 
19 #include <string>
20 
21 #include "nav2_behavior_tree/bt_action_node.hpp"
22 #include "nav2_msgs/action/assisted_teleop.hpp"
23 #include "nav2_ros_common/lifecycle_node.hpp"
24 
25 namespace nav2_behavior_tree
26 {
27 
33 class AssistedTeleopAction : public BtActionNode<nav2_msgs::action::AssistedTeleop>
34 {
35  using Action = nav2_msgs::action::AssistedTeleop;
36  using ActionResult = Action::Result;
37 
38 public:
46  const std::string & xml_tag_name,
47  const std::string & action_name,
48  const BT::NodeConfiguration & conf);
49 
53  void on_tick() override;
54 
58  BT::NodeStatus on_success() override;
59 
63  BT::NodeStatus on_aborted() override;
64 
68  BT::NodeStatus on_cancelled() override;
69 
74  void on_timeout() override;
75 
79  void initialize();
80 
85  static BT::PortsList providedPorts()
86  {
87  return providedBasicPorts(
88  {
89  BT::InputPort<double>("time_allowance", 10.0, "Allowed time for running assisted teleop"),
90  BT::InputPort<bool>("is_recovery", false, "If true the recovery count will be incremented"),
91  BT::OutputPort<ActionResult::_error_code_type>(
92  "error_code_id", "The assisted teleop behavior server error code"),
93  BT::OutputPort<std::string>(
94  "error_msg", "The assisted teleop behavior server error msg"),
95  });
96  }
97 
98 private:
99  bool is_recovery_;
100 };
101 
102 } // namespace nav2_behavior_tree
103 
104 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__ACTION__ASSISTED_TELEOP_ACTION_HPP_
A nav2_behavior_tree::BtActionNode class that wraps nav2_msgs::action::AssistedTeleop.
BT::NodeStatus on_aborted() override
Function to perform some user-defined operation upon abortion of the action.
AssistedTeleopAction(const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
A constructor for nav2_behavior_tree::nav2_msgs::action::AssistedTeleop.
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_success() override
Function to perform some user-defined operation upon successful completion of the action.
BT::NodeStatus on_cancelled() override
Function to perform some user-defined operation upon cancellation of the action.
void on_tick() override
Function to perform some user-defined operation on tick.
void initialize()
Function to read parameters and initialize class variables.
static BT::PortsList providedPorts()
Creates list of BT ports.
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...