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

#include <blackboard.h>

Public Types

typedef std::shared_ptr< BlackboardPtr
 

Public Member Functions

 Blackboard ()=delete
 
bool contains (const std::string &key) const
 
template<typename T >
bool get (const std::string &key, T &value) const
 
template<typename T >
get (const std::string &key) const
 
const SafeAny::AnygetAny (const std::string &key) const
 
template<typename T >
void set (const std::string &key, const T &value)
 Update the entry with the given key. More...
 
virtual ~Blackboard ()=default
 

Static Public Member Functions

template<typename ImplClass , typename... Args>
static Blackboard::Ptr create (Args...args)
 

Private Member Functions

 Blackboard (std::unique_ptr< BlackboardImpl > base)
 

Private Attributes

std::unique_ptr< BlackboardImplimpl_
 

Detailed Description

Definition at line 32 of file blackboard.h.

Member Typedef Documentation

typedef std::shared_ptr<Blackboard> BT::Blackboard::Ptr

Definition at line 40 of file blackboard.h.

Constructor & Destructor Documentation

BT::Blackboard::Blackboard ( std::unique_ptr< BlackboardImpl base)
inlineprivate

Definition at line 35 of file blackboard.h.

BT::Blackboard::Blackboard ( )
delete
virtual BT::Blackboard::~Blackboard ( )
virtualdefault

Member Function Documentation

bool BT::Blackboard::contains ( const std::string &  key) const
inline

Definition at line 110 of file blackboard.h.

template<typename ImplClass , typename... Args>
static Blackboard::Ptr BT::Blackboard::create ( Args...  args)
inlinestatic

Use this static method to create an instance of the BlackBoard to share among all your NodeTrees.

Definition at line 48 of file blackboard.h.

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.

return true if succesful

Definition at line 62 of file blackboard.h.

template<typename T >
T BT::Blackboard::get ( const std::string &  key) const
inline

Definition at line 89 of file blackboard.h.

const SafeAny::Any* BT::Blackboard::getAny ( const std::string &  key) const
inline

Definition at line 78 of file blackboard.h.

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 102 of file blackboard.h.

Member Data Documentation

std::unique_ptr<BlackboardImpl> BT::Blackboard::impl_
private

Definition at line 116 of file blackboard.h.


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


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