Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
BT::BlackboardPreconditionNode< T > Class Template Reference

#include <blackboard_precondition.h>

Inheritance diagram for BT::BlackboardPreconditionNode< T >:
Inheritance graph
[legend]

Public Member Functions

 BlackboardPreconditionNode (const std::string &name, const NodeConfiguration &config)
 
virtual ~BlackboardPreconditionNode () override=default
 
- Public Member Functions inherited from BT::DecoratorNode
const TreeNodechild () const
 
TreeNodechild ()
 
 DecoratorNode (const std::string &name, const NodeConfiguration &config)
 
NodeStatus executeTick () override
 The method that should be used to invoke tick() and setStatus();. More...
 
virtual void halt () override
 The method used to interrupt the execution of this node. More...
 
void haltChild ()
 Halt() the child node. More...
 
void setChild (TreeNode *child)
 
virtual NodeType type () const override
 
virtual ~DecoratorNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const NodeConfigurationconfig () const
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Optional< T > getInput (const std::string &key) const
 
bool isHalted () const
 
const std::string & name () const
 Name of the instance, not the type. More...
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
template<typename T >
Result setOutput (const std::string &key, const T &value)
 
void setStatus (NodeStatus new_status)
 
NodeStatus status () const
 
StatusChangeSubscriber subscribeToStatusChange (StatusChangeCallback callback)
 subscribeToStatusChange is used to attach a callback to a status change. When StatusChangeSubscriber goes out of scope (it is a shared_ptr) the callback is unsubscribed automatically. More...
 
 TreeNode (std::string name, NodeConfiguration config)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Static Public Member Functions

static PortsList providedPorts ()
 
- Static Public Member Functions inherited from BT::TreeNode
static Optional< StringViewgetRemappedKey (StringView port_name, StringView remapping_value)
 
static bool isBlackboardPointer (StringView str)
 
static StringView stripBlackboardPointer (StringView str)
 

Private Member Functions

virtual BT::NodeStatus tick () override
 Method to be implemented by the user. More...
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
- Protected Member Functions inherited from BT::TreeNode
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
void setRegistrationID (StringView ID)
 
- Protected Attributes inherited from BT::DecoratorNode
TreeNodechild_node_
 

Detailed Description

template<typename T>
class BT::BlackboardPreconditionNode< T >

This node excute its child only if the value of a given input port is equal to the expected one. If this precondition is met, this node will return the same status of the child, otherwise it will return the value specified in "return_on_mismatch".

Example:

<BlackboardCheckInt value_a="{the_answer}" value_b="42" return_on_mismatch="FAILURE">

Definition at line 33 of file blackboard_precondition.h.

Constructor & Destructor Documentation

template<typename T >
BT::BlackboardPreconditionNode< T >::BlackboardPreconditionNode ( const std::string &  name,
const NodeConfiguration config 
)
inline

Definition at line 36 of file blackboard_precondition.h.

template<typename T >
virtual BT::BlackboardPreconditionNode< T >::~BlackboardPreconditionNode ( )
overridevirtualdefault

Member Function Documentation

template<typename T >
static PortsList BT::BlackboardPreconditionNode< T >::providedPorts ( )
inlinestatic

Definition at line 49 of file blackboard_precondition.h.

template<typename T >
NodeStatus BT::BlackboardPreconditionNode< T >::tick ( )
inlineoverrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 63 of file blackboard_precondition.h.


The documentation for this class was generated from the following file:


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sat Jun 8 2019 18:04:06