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

Use a Terminal User Interface (ncurses) to select a certain child manually. More...

#include <manual_node.h>

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

Public Member Functions

virtual void halt () override
 
 ManualSelectorNode (const std::string &name, const NodeConfiguration &config)
 
virtual ~ManualSelectorNode () override=default
 
- Public Member Functions inherited from BT::ControlNode
void addChild (TreeNode *child)
 The method used to add nodes to the children vector. More...
 
const TreeNodechild (size_t index) const
 
const std::vector< TreeNode * > & children () const
 
size_t childrenCount () const
 
 ControlNode (const std::string &name, const NodeConfiguration &config)
 
void haltChild (size_t i)
 
void haltChildren ()
 same as resetChildren() More...
 
void haltChildren (size_t first)
 
void resetChildren ()
 
virtual NodeType type () const override final
 
virtual ~ControlNode () 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
 

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 Types

enum  NumericarStatus { NUM_SUCCESS = 253, NUM_FAILURE = 254, NUM_RUNNING = 255 }
 

Private Member Functions

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

Private Attributes

int previously_executed_idx_
 
int running_child_idx_
 

Static Private Attributes

static constexpr const char * REPEAT_LAST_SELECTION = "repeat_last_selection"
 

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
 
- 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)
 
- Protected Attributes inherited from BT::ControlNode
std::vector< TreeNode * > children_nodes_
 

Detailed Description

Use a Terminal User Interface (ncurses) to select a certain child manually.

Definition at line 22 of file manual_node.h.

Member Enumeration Documentation

◆ NumericarStatus

Enumerator
NUM_SUCCESS 
NUM_FAILURE 
NUM_RUNNING 

Definition at line 46 of file manual_node.h.

Constructor & Destructor Documentation

◆ ManualSelectorNode()

BT::ManualSelectorNode::ManualSelectorNode ( const std::string &  name,
const NodeConfiguration config 
)

Definition at line 20 of file manual_node.cpp.

◆ ~ManualSelectorNode()

virtual BT::ManualSelectorNode::~ManualSelectorNode ( )
overridevirtualdefault

Member Function Documentation

◆ halt()

void BT::ManualSelectorNode::halt ( )
overridevirtual

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

Reimplemented from BT::ControlNode.

Definition at line 29 of file manual_node.cpp.

◆ providedPorts()

static PortsList BT::ManualSelectorNode::providedPorts ( )
inlinestatic

Definition at line 31 of file manual_node.h.

◆ selectChild()

uint8_t BT::ManualSelectorNode::selectChild ( ) const
private

Definition at line 131 of file manual_node.cpp.

◆ selectStatus()

NodeStatus BT::ManualSelectorNode::selectStatus ( ) const
private

Definition at line 85 of file manual_node.cpp.

◆ tick()

NodeStatus BT::ManualSelectorNode::tick ( )
overrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 39 of file manual_node.cpp.

Member Data Documentation

◆ previously_executed_idx_

int BT::ManualSelectorNode::previously_executed_idx_
private

Definition at line 44 of file manual_node.h.

◆ REPEAT_LAST_SELECTION

constexpr const char* BT::ManualSelectorNode::REPEAT_LAST_SELECTION = "repeat_last_selection"
staticprivate

Definition at line 40 of file manual_node.h.

◆ running_child_idx_

int BT::ManualSelectorNode::running_child_idx_
private

Definition at line 43 of file manual_node.h.


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


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