Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
BT::SwitchNode< NUM_CASES > Class Template Reference

#include <switch_node.h>

Inheritance diagram for BT::SwitchNode< NUM_CASES >:
Inheritance graph
[legend]

Public Member Functions

void halt () override
 
 SwitchNode (const std::string &name, const BT::NodeConfig &config)
 
virtual ~SwitchNode () 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 NodeConfig &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 NodeConfigconfig () const
 
void emitWakeUpSignal ()
 Notify that the tree should be ticked again() More...
 
virtual BT::NodeStatus executeTick ()
 The method that should be used to invoke tick() and setStatus();. More...
 
const std::string & fullPath () const
 
template<typename T >
Expected< T > getInput (const std::string &key) const
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Expected< StampedValue< T > > getInputStamped (const std::string &key) const
 
template<typename T >
Expected< TimestampgetInputStamped (const std::string &key, T &destination) const
 getInputStamped is similar to getInput(dey, destination), but it returne also the Timestamp object, that can be used to check if a value was updated and when. More...
 
AnyPtrLocked getLockedPortContent (const std::string &key)
 getLockedPortContent should be used when: More...
 
StringView getRawPortValue (const std::string &key) const
 
void haltNode ()
 
bool isHalted () const
 
const std::string & name () const
 Name of the instance, not the type. More...
 
TreeNodeoperator= (const TreeNode &other)=delete
 
TreeNodeoperator= (TreeNode &&other) noexcept
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
bool requiresWakeUp () const
 
template<typename T >
Result setOutput (const std::string &key, const T &value)
 setOutput modifies the content of an Output port More...
 
void setPostTickFunction (PostTickCallback callback)
 
void setPreTickFunction (PreTickCallback callback)
 
void setTickMonitorCallback (TickMonitorCallback 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 (const TreeNode &other)=delete
 
 TreeNode (std::string name, NodeConfig config)
 TreeNode main constructor. More...
 
 TreeNode (TreeNode &&other) noexcept
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()
 

Static Public Member Functions

static PortsList providedPorts ()
 
- Static Public Member Functions inherited from BT::TreeNode
static Expected< StringViewgetRemappedKey (StringView port_name, StringView remapped_port)
 
template<class DerivedT , typename... ExtraArgs>
static std::unique_ptr< TreeNodeInstantiate (const std::string &name, const NodeConfig &config, ExtraArgs... args)
 
static bool isBlackboardPointer (StringView str, StringView *stripped_pointer=nullptr)
 Check a string and return true if it matches the pattern: {...}. More...
 
static StringView stripBlackboardPointer (StringView str)
 

Private Member Functions

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

Private Attributes

std::vector< std::string > case_keys_
 
int running_child_
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
using PostTickCallback = std::function< NodeStatus(TreeNode &, NodeStatus)>
 
using PreTickCallback = std::function< NodeStatus(TreeNode &)>
 
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
using TickMonitorCallback = std::function< void(TreeNode &, NodeStatus, std::chrono::microseconds)>
 
- Protected Types inherited from BT::TreeNode
using PostScripts = std::array< ScriptFunction, size_t(PostCond::COUNT_)>
 
using PreScripts = std::array< ScriptFunction, size_t(PreCond::COUNT_)>
 
- Protected Member Functions inherited from BT::TreeNode
NodeConfigconfig ()
 
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
template<typename T >
parseString (const std::string &str) const
 
PostScriptspostConditionsScripts ()
 
PreScriptspreConditionsScripts ()
 
void resetStatus ()
 Set the status to IDLE. More...
 
void setRegistrationID (StringView ID)
 
void setStatus (NodeStatus new_status)
 setStatus changes the status of the node. it will throw if you try to change the status to IDLE, because your parent node should do that, not the user! More...
 
void setWakeUpInstance (std::shared_ptr< WakeUpSignal > instance)
 
- Protected Attributes inherited from BT::ControlNode
std::vector< TreeNode * > children_nodes_
 

Detailed Description

template<size_t NUM_CASES>
class BT::SwitchNode< NUM_CASES >

Definition at line 50 of file switch_node.h.

Constructor & Destructor Documentation

◆ SwitchNode()

template<size_t NUM_CASES>
BT::SwitchNode< NUM_CASES >::SwitchNode ( const std::string &  name,
const BT::NodeConfig config 
)
inline

Definition at line 71 of file switch_node.h.

◆ ~SwitchNode()

template<size_t NUM_CASES>
virtual BT::SwitchNode< NUM_CASES >::~SwitchNode ( )
overridevirtualdefault

Member Function Documentation

◆ halt()

template<size_t NUM_CASES>
void BT::SwitchNode< NUM_CASES >::halt ( )
inlineoverridevirtual

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 83 of file switch_node.h.

◆ providedPorts()

template<size_t NUM_CASES>
PortsList BT::SwitchNode< NUM_CASES >::providedPorts
inlinestatic

Definition at line 90 of file switch_node.h.

◆ tick()

template<size_t NUM_CASES>
NodeStatus BT::SwitchNode< NUM_CASES >::tick ( )
inlineoverrideprivatevirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 107 of file switch_node.h.

Member Data Documentation

◆ case_keys_

template<size_t NUM_CASES>
std::vector<std::string> BT::SwitchNode< NUM_CASES >::case_keys_
private

Definition at line 63 of file switch_node.h.

◆ running_child_

template<size_t NUM_CASES>
int BT::SwitchNode< NUM_CASES >::running_child_
private

Definition at line 62 of file switch_node.h.


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


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