The Blackboard is the mechanism used by BehaviorTrees to exchange typed data.
More...
#include <blackboard.h>
The Blackboard is the mechanism used by BehaviorTrees to exchange typed data.
Definition at line 32 of file blackboard.h.
◆ Ptr
◆ Blackboard()
◆ ~Blackboard()
| virtual BT::Blackboard::~Blackboard |
( |
| ) |
|
|
virtualdefault |
◆ addSubtreeRemapping()
◆ clear()
| void BT::Blackboard::clear |
( |
| ) |
|
◆ cloneInto()
| void BT::Blackboard::cloneInto |
( |
Blackboard & |
dst | ) |
const |
cloneInto copies the values of the entries into another blackboard. Known limitations:
- it doesn't update the remapping in dst
- it doesn't change the parent blackboard os dst
- Parameters
-
| dst | destination, i.e. blackboard to be updated |
Definition at line 154 of file blackboard.cpp.
◆ create()
Use this static method to create an instance of the BlackBoard to share among all your NodeTrees.
Definition at line 63 of file blackboard.h.
◆ createEntry()
| void BT::Blackboard::createEntry |
( |
const std::string & |
key, |
|
|
const TypeInfo & |
info |
|
) |
| |
◆ createEntryImpl()
◆ debugMessage()
| void BT::Blackboard::debugMessage |
( |
| ) |
const |
◆ enableAutoRemapping()
| void BT::Blackboard::enableAutoRemapping |
( |
bool |
remapping | ) |
|
◆ entryInfo()
| const TypeInfo * BT::Blackboard::entryInfo |
( |
const std::string & |
key | ) |
|
◆ entryMutex()
| std::recursive_mutex & BT::Blackboard::entryMutex |
( |
| ) |
const |
◆ get() [1/2]
template<typename T >
| T BT::Blackboard::get |
( |
const std::string & |
key | ) |
const |
|
inline |
◆ get() [2/2]
template<typename T >
| bool BT::Blackboard::get |
( |
const std::string & |
key, |
|
|
T & |
value |
|
) |
| const |
|
inline |
Return true if the entry with the given key was found. Note that this method may throw an exception if the cast to T failed.
Definition at line 313 of file blackboard.h.
◆ getAny() [1/2]
| Any * BT::Blackboard::getAny |
( |
const std::string & |
key | ) |
|
◆ getAny() [2/2]
| const Any * BT::Blackboard::getAny |
( |
const std::string & |
key | ) |
const |
◆ getAnyLocked() [1/2]
| AnyPtrLocked BT::Blackboard::getAnyLocked |
( |
const std::string & |
key | ) |
|
◆ getAnyLocked() [2/2]
| AnyPtrLocked BT::Blackboard::getAnyLocked |
( |
const std::string & |
key | ) |
const |
◆ getEntry() [1/2]
| std::shared_ptr< Blackboard::Entry > BT::Blackboard::getEntry |
( |
const std::string & |
key | ) |
|
◆ getEntry() [2/2]
| const std::shared_ptr< Blackboard::Entry > BT::Blackboard::getEntry |
( |
const std::string & |
key | ) |
const |
◆ getKeys()
| std::vector< StringView > BT::Blackboard::getKeys |
( |
| ) |
const |
◆ getStamped() [1/2]
◆ getStamped() [2/2]
template<typename T >
| Expected< Timestamp > BT::Blackboard::getStamped |
( |
const std::string & |
key, |
|
|
T & |
value |
|
) |
| const |
|
inline |
◆ parent()
◆ rootBlackboard() [1/2]
| const Blackboard * BT::Blackboard::rootBlackboard |
( |
| ) |
|
◆ rootBlackboard() [2/2]
| const Blackboard* BT::Blackboard::rootBlackboard |
( |
| ) |
const |
◆ set()
template<typename T >
| void BT::Blackboard::set |
( |
const std::string & |
key, |
|
|
const T & |
value |
|
) |
| |
|
inline |
Update the entry with the given key.
Definition at line 203 of file blackboard.h.
◆ unset()
| void BT::Blackboard::unset |
( |
const std::string & |
key | ) |
|
|
inline |
◆ autoremapping_
| bool BT::Blackboard::autoremapping_ = false |
|
private |
◆ entry_mutex_
| std::recursive_mutex BT::Blackboard::entry_mutex_ |
|
mutableprivate |
◆ internal_to_external_
| std::unordered_map<std::string, std::string> BT::Blackboard::internal_to_external_ |
|
private |
◆ mutex_
◆ parent_bb_
| std::weak_ptr<Blackboard> BT::Blackboard::parent_bb_ |
|
private |
◆ storage_
| std::unordered_map<std::string, std::shared_ptr<Entry> > BT::Blackboard::storage_ |
|
private |
The documentation for this class was generated from the following files: