Public Member Functions | Private Attributes | List of all members
FollowPath Class Reference
Inheritance diagram for FollowPath:
Inheritance graph
[legend]

Public Member Functions

 FollowPath (const std::string &name)
 
void halt () override
 
NodeStatus tick () override
 Method to be implemented by the user. More...
 
bool wasHalted () const
 
- Public Member Functions inherited from BT::ActionNodeBase
 ActionNodeBase (const std::string &name, const NodeConfiguration &config)
 
virtual NodeType type () const override final
 
 ~ActionNodeBase () override=default
 
- Public Member Functions inherited from BT::LeafNode
 LeafNode (const std::string &name, const NodeConfiguration &config)
 
virtual ~LeafNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const NodeConfigurationconfig () const
 
void emitStateChanged ()
 
virtual BT::NodeStatus executeTick ()
 The method that should be used to invoke tick() and setStatus();. More...
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Optional< T > getInput (const std::string &key) const
 
StringView getRawPortValue (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 setPostTickOverrideFunction (PostTickOverrideCallback callback)
 
void setPreTickOverrideFunction (PreTickOverrideCallback callback)
 
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
 
- Public Member Functions inherited from TestNode
NodeStatus expectedResult () const
 
void resetTickCount ()
 
void setExpectedResult (bool will_succeed)
 
 TestNode (const std::string &name)
 
int tickCount () const
 
NodeStatus tickImpl ()
 

Private Attributes

bool _halted
 
std::chrono::high_resolution_clock::time_point _initial_time
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
using PostTickOverrideCallback = std::function< Optional< NodeStatus >(TreeNode &, NodeStatus, NodeStatus)>
 
using PreTickOverrideCallback = std::function< Optional< NodeStatus >(TreeNode &, NodeStatus)>
 
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
- 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)
 
- Protected Member Functions inherited from BT::TreeNode
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
void resetStatus ()
 Equivalent to setStatus(NodeStatus::IDLE) More...
 
void setRegistrationID (StringView ID)
 
void setStatus (NodeStatus new_status)
 
void setWakeUpInstance (std::shared_ptr< WakeUpSignal > instance)
 

Detailed Description

Definition at line 117 of file navigation_test.cpp.

Constructor & Destructor Documentation

◆ FollowPath()

FollowPath::FollowPath ( const std::string &  name)
inline

Definition at line 122 of file navigation_test.cpp.

Member Function Documentation

◆ halt()

void FollowPath::halt ( )
inlineoverridevirtual

The method used to interrupt the execution of a RUNNING node. Only Async nodes that may return RUNNING should implement it.

Implements BT::TreeNode.

Definition at line 147 of file navigation_test.cpp.

◆ tick()

NodeStatus FollowPath::tick ( )
inlineoverridevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 126 of file navigation_test.cpp.

◆ wasHalted()

bool FollowPath::wasHalted ( ) const
inline

Definition at line 153 of file navigation_test.cpp.

Member Data Documentation

◆ _halted

bool FollowPath::_halted
private

Definition at line 159 of file navigation_test.cpp.

◆ _initial_time

std::chrono::high_resolution_clock::time_point FollowPath::_initial_time
private

Definition at line 119 of file navigation_test.cpp.


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


behaviortree_cpp_v3
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Mon Jul 3 2023 02:50:14