condition_node.h
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 
14 #ifndef CONDITIONNODE_H
15 #define CONDITIONNODE_H
16 
17 #include "leaf_node.h"
18 
19 namespace BT
20 {
21 class ConditionNode : public LeafNode
22 {
23 public:
24  ConditionNode(const std::string& name, const NodeConfig& config);
25 
26  virtual ~ConditionNode() override = default;
27 
28  //Do nothing
29  virtual void halt() override final
30  {
31  resetStatus();
32  }
33 
34  virtual NodeType type() const override final
35  {
36  return NodeType::CONDITION;
37  }
38 };
39 
51 {
52 public:
53  using TickFunctor = std::function<NodeStatus(TreeNode&)>;
54 
55  // You must provide the function to call when tick() is invoked
56  SimpleConditionNode(const std::string& name, TickFunctor tick_functor,
57  const NodeConfig& config);
58 
59  ~SimpleConditionNode() override = default;
60 
61 protected:
62  virtual NodeStatus tick() override;
63 
65 };
66 } // namespace BT
67 
68 #endif
BT
Definition: ex01_wrap_legacy.cpp:29
BT::NodeType
NodeType
Enumerates the possible types of nodes.
Definition: basic_types.h:20
BT::ConditionNode
Definition: condition_node.h:21
BT::LeafNode
Definition: leaf_node.h:21
BT::TreeNode::config
const NodeConfig & config() const
Definition: tree_node.cpp:345
BT::ConditionNode::~ConditionNode
virtual ~ConditionNode() override=default
BT::NodeType::CONDITION
@ CONDITION
BT::TreeNode
Abstract base class for Behavior Tree Nodes.
Definition: tree_node.h:118
BT::ConditionNode::ConditionNode
ConditionNode(const std::string &name, const NodeConfig &config)
Definition: condition_node.cpp:18
BT::TreeNode::name
const std::string & name() const
Name of the instance, not the type.
Definition: tree_node.cpp:296
BT::TreeNode::resetStatus
void resetStatus()
Set the status to IDLE.
Definition: tree_node.cpp:262
BT::SimpleConditionNode::TickFunctor
std::function< NodeStatus(TreeNode &)> TickFunctor
Definition: condition_node.h:53
BT::ConditionNode::type
virtual NodeType type() const override final
Definition: condition_node.h:34
leaf_node.h
BT::SimpleConditionNode
The SimpleConditionNode provides an easy to use ConditionNode. The user should simply provide a callb...
Definition: condition_node.h:50
BT::NodeConfig
Definition: tree_node.h:73
BT::SimpleConditionNode::tick
virtual NodeStatus tick() override
Method to be implemented by the user.
Definition: condition_node.cpp:28
BT::SimpleConditionNode::tick_functor_
TickFunctor tick_functor_
Definition: condition_node.h:64
BT::ConditionNode::halt
virtual void halt() override final
Definition: condition_node.h:29
BT::SimpleConditionNode::SimpleConditionNode
SimpleConditionNode(const std::string &name, TickFunctor tick_functor, const NodeConfig &config)
Definition: condition_node.cpp:22
BT::NodeStatus
NodeStatus
Definition: basic_types.h:33
BT::SimpleConditionNode::~SimpleConditionNode
~SimpleConditionNode() override=default


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Jun 28 2024 02:20:07