repeat_node.cpp
Go to the documentation of this file.
1 /* Copyright (C) 2015-2018 Michele Colledanchise - All Rights Reserved
2  * Copyright (C) 2018-2020 Davide Faconti, Eurecat - All Rights Reserved
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
5 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
6 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
7 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
10 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
11 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12 */
13 
15 
16 namespace BT
17 {
18 constexpr const char* RepeatNode::NUM_CYCLES;
19 
20 RepeatNode::RepeatNode(const std::string& name, int NTries) :
21  DecoratorNode(name, {}),
22  num_cycles_(NTries),
23  repeat_count_(0),
24  read_parameter_from_ports_(false)
25 {
26  setRegistrationID("Repeat");
27 }
28 
29 RepeatNode::RepeatNode(const std::string& name, const NodeConfiguration& config) :
30  DecoratorNode(name, config),
31  num_cycles_(0),
32  repeat_count_(0),
33  read_parameter_from_ports_(true)
34 {}
35 
37 {
39  {
41  {
42  throw RuntimeError("Missing parameter [", NUM_CYCLES, "] in RepeatNode");
43  }
44  }
45 
47 
48  while (repeat_count_ < num_cycles_ || num_cycles_ == -1)
49  {
50  NodeStatus child_state = child_node_->executeTick();
51 
52  switch (child_state)
53  {
54  case NodeStatus::SUCCESS: {
55  repeat_count_++;
56  resetChild();
57  }
58  break;
59 
60  case NodeStatus::FAILURE: {
61  repeat_count_ = 0;
62  resetChild();
63  return (NodeStatus::FAILURE);
64  }
65 
66  case NodeStatus::RUNNING: {
67  return NodeStatus::RUNNING;
68  }
69 
70  default: {
71  throw LogicError("A child node must never return IDLE");
72  }
73  }
74  }
75 
76  repeat_count_ = 0;
77  return NodeStatus::SUCCESS;
78 }
79 
81 {
82  repeat_count_ = 0;
84 }
85 
86 } // namespace BT
BT::TreeNode::getInput
Result getInput(const std::string &key, T &destination) const
Definition: tree_node.h:232
BT
Definition: ex01_wrap_legacy.cpp:29
BT::TreeNode::executeTick
virtual BT::NodeStatus executeTick()
The method that should be used to invoke tick() and setStatus();.
Definition: tree_node.cpp:32
BT::DecoratorNode
Definition: decorator_node.h:8
BT::LogicError
Definition: exceptions.h:45
BT::NodeConfiguration
Definition: tree_node.h:44
BT::RepeatNode::repeat_count_
int repeat_count_
Definition: repeat_node.h:52
BT::NodeStatus::FAILURE
@ FAILURE
BT::TreeNode::setStatus
void setStatus(NodeStatus new_status)
Definition: tree_node.cpp:63
BT::RepeatNode::tick
virtual NodeStatus tick() override
Method to be implemented by the user.
Definition: repeat_node.cpp:36
BT::RuntimeError
Definition: exceptions.h:58
repeat_node.h
BT::NodeStatus::SUCCESS
@ SUCCESS
BT::RepeatNode::RepeatNode
RepeatNode(const std::string &name, int NTries)
Definition: repeat_node.cpp:20
BT::NodeStatus::RUNNING
@ RUNNING
BT::RepeatNode::NUM_CYCLES
static constexpr const char * NUM_CYCLES
Definition: repeat_node.h:55
BT::DecoratorNode::halt
virtual void halt() override
The method used to interrupt the execution of this node.
Definition: decorator_node.cpp:32
BT::RepeatNode::read_parameter_from_ports_
bool read_parameter_from_ports_
Definition: repeat_node.h:54
BT::RepeatNode::num_cycles_
int num_cycles_
Definition: repeat_node.h:51
BT::DecoratorNode::resetChild
void resetChild()
Definition: decorator_node.cpp:52
BT::RepeatNode::halt
void halt() override
The method used to interrupt the execution of this node.
Definition: repeat_node.cpp:80
BT::NodeStatus
NodeStatus
Definition: basic_types.h:35
BT::DecoratorNode::child_node_
TreeNode * child_node_
Definition: decorator_node.h:11


behaviortree_cpp_v3
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Wed Jun 26 2024 02:51:19