Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
round_robin_node.hpp
1 // Copyright (c) 2019 Intel Corporation
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__CONTROL__ROUND_ROBIN_NODE_HPP_
16 #define NAV2_BEHAVIOR_TREE__PLUGINS__CONTROL__ROUND_ROBIN_NODE_HPP_
17 
18 #include <string>
19 
20 #include "behaviortree_cpp/control_node.h"
21 #include "behaviortree_cpp/bt_factory.h"
22 
23 namespace nav2_behavior_tree
24 {
25 
54 class RoundRobinNode : public BT::ControlNode
55 {
56 public:
61  explicit RoundRobinNode(const std::string & name);
62 
68  RoundRobinNode(const std::string & name, const BT::NodeConfiguration & config);
69 
74  BT::NodeStatus tick() override;
75 
79  void halt() override;
80 
85  static BT::PortsList providedPorts() {return {};}
86 
87 private:
88  unsigned int current_child_idx_{0};
89  unsigned int num_failed_children_{0};
90 };
91 
92 } // namespace nav2_behavior_tree
93 
94 #endif // NAV2_BEHAVIOR_TREE__PLUGINS__CONTROL__ROUND_ROBIN_NODE_HPP_
Type of sequence node that ticks children in a round-robin fashion.
void halt() override
The other (optional) override required by a BT action to reset node state.
static BT::PortsList providedPorts()
Creates list of BT ports.
BT::NodeStatus tick() override
The main override required by a BT action.
RoundRobinNode(const std::string &name)
A constructor for nav2_behavior_tree::RoundRobinNode.