Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
BT::TimeoutNode Class Reference

#include <timeout_node.h>

Inheritance diagram for BT::TimeoutNode:
Inheritance graph
[legend]

Public Member Functions

 TimeoutNode (const std::string &name, unsigned milliseconds)
 
 TimeoutNode (const std::string &name, const NodeParameters &params)
 
- Public Member Functions inherited from BT::DecoratorNode
const TreeNodechild () const
 
TreeNodechild ()
 
 DecoratorNode (const std::string &name, const NodeParameters &parameters)
 
NodeStatus executeTick () override
 The method that will be executed to invoke tick(); and setStatus();. More...
 
virtual void halt () override
 The method used to interrupt the execution of a RUNNING node. More...
 
void haltChild ()
 
void setChild (TreeNode *child)
 
virtual NodeType type () const override
 
virtual ~DecoratorNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const Blackboard::Ptrblackboard () const
 
template<typename T >
BT::optional< T > getParam (const std::string &key) const
 
template<typename T >
bool getParam (const std::string &key, T &destination) const
 
const NodeParametersinitializationParameters () const
 
bool isHalted () const
 
const std::string & name () const
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
void setBlackboard (const Blackboard::Ptr &bb)
 
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 (const std::string &name, const NodeParameters &parameters)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Static Public Member Functions

static const NodeParametersrequiredNodeParameters ()
 
- Static Public Member Functions inherited from BT::TreeNode
static bool isBlackboardPattern (StringView str)
 

Private Member Functions

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

Static Private Member Functions

static TimerQueuetimer ()
 

Private Attributes

std::atomic< bool > child_halted_
 
unsigned msec_
 
bool read_parameter_from_blackboard_
 
uint64_t timer_id_
 

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 initializeOnce ()
 
void setRegistrationName (const std::string &registration_name)
 registrationName() is set by the BehaviorTreeFactory More...
 
- Protected Attributes inherited from BT::DecoratorNode
TreeNodechild_node_
 

Detailed Description

Definition at line 10 of file timeout_node.h.

Constructor & Destructor Documentation

BT::TimeoutNode::TimeoutNode ( const std::string &  name,
unsigned  milliseconds 
)

Definition at line 16 of file timeout_node.cpp.

BT::TimeoutNode::TimeoutNode ( const std::string &  name,
const NodeParameters params 
)

Definition at line 23 of file timeout_node.cpp.

Member Function Documentation

static const NodeParameters& BT::TimeoutNode::requiredNodeParameters ( )
inlinestatic

Definition at line 17 of file timeout_node.h.

NodeStatus BT::TimeoutNode::tick ( )
overrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 36 of file timeout_node.cpp.

static TimerQueue& BT::TimeoutNode::timer ( )
inlinestaticprivate

Definition at line 24 of file timeout_node.h.

Member Data Documentation

std::atomic<bool> BT::TimeoutNode::child_halted_
private

Definition at line 32 of file timeout_node.h.

unsigned BT::TimeoutNode::msec_
private

Definition at line 35 of file timeout_node.h.

bool BT::TimeoutNode::read_parameter_from_blackboard_
private

Definition at line 36 of file timeout_node.h.

uint64_t BT::TimeoutNode::timer_id_
private

Definition at line 33 of file timeout_node.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sun Feb 3 2019 03:14:33