Fawkes API  Fawkes Development Version
fawkes::EclExternalBlackBoard Class Reference

Wrapper class for using the blackboard in the implementation of the external predicates. More...

#include <blackboard.h>

Public Member Functions

 ~EclExternalBlackBoard ()
 Destructor. More...
 
void connect (const char *host, long port)
 Open remote blackboard connection. More...
 
bool connected ()
 Query connection status. More...
 
void disconnect ()
 Disconnect remote blackboard connection. More...
 
std::map< std::string, Interface * > & interfaces ()
 Obtain the list of opened interfaces. More...
 

Static Public Member Functions

static void create_initial_object (BlackBoard *bb)
 Creates the initial EclExternalBlackBoard object. More...
 
static void cleanup_instance ()
 Delete the current EclExternalBlackBoard instance and set it to NULL. More...
 
static EclExternalBlackBoardinstance ()
 Get the EclExternalBlackBoard instance. More...
 
static BlackBoardblackboard_instance ()
 Access the BlackBoard instance. More...
 

Detailed Description

Wrapper class for using the blackboard in the implementation of the external predicates.

Author
Daniel Beck

Definition at line 39 of file blackboard.h.

Constructor & Destructor Documentation

◆ ~EclExternalBlackBoard()

fawkes::EclExternalBlackBoard::~EclExternalBlackBoard ( )

Destructor.

Definition at line 65 of file blackboard.cpp.

References fawkes::BlackBoard::close().

Member Function Documentation

◆ blackboard_instance()

BlackBoard * fawkes::EclExternalBlackBoard::blackboard_instance ( )
static

Access the BlackBoard instance.

Returns
the blackboard instance

Definition at line 145 of file blackboard.cpp.

Referenced by interfaces().

◆ cleanup_instance()

void fawkes::EclExternalBlackBoard::cleanup_instance ( )
static

Delete the current EclExternalBlackBoard instance and set it to NULL.

Definition at line 85 of file blackboard.cpp.

Referenced by EclipseAgentThread::finalize().

◆ connect()

void fawkes::EclExternalBlackBoard::connect ( const char *  host,
long  port 
)

Open remote blackboard connection.

Parameters
hostthe host running Fawkes
portthe host's port to connect to

Definition at line 112 of file blackboard.cpp.

Referenced by interfaces().

◆ connected()

bool fawkes::EclExternalBlackBoard::connected ( )

Query connection status.

Returns
true if connected; false otherwise

Definition at line 124 of file blackboard.cpp.

Referenced by interfaces().

◆ create_initial_object()

void fawkes::EclExternalBlackBoard::create_initial_object ( BlackBoard bb)
static

Creates the initial EclExternalBlackBoard object.

Parameters
bbpointer to the BlackBoard to be used

Definition at line 79 of file blackboard.cpp.

Referenced by EclipseAgentThread::init().

◆ disconnect()

void fawkes::EclExternalBlackBoard::disconnect ( )

Disconnect remote blackboard connection.

Definition at line 130 of file blackboard.cpp.

References fawkes::BlackBoard::close().

Referenced by interfaces().

◆ instance()

EclExternalBlackBoard * fawkes::EclExternalBlackBoard::instance ( )
static

Get the EclExternalBlackBoard instance.

Returns
the instance

Definition at line 97 of file blackboard.cpp.

Referenced by interfaces().

◆ interfaces()

std::map< std::string, Interface * > & fawkes::EclExternalBlackBoard::interfaces ( )

Obtain the list of opened interfaces.

Returns
list of opened interfaces

Definition at line 156 of file blackboard.cpp.

References blackboard_instance(), fawkes::BlackBoard::close(), connect(), connected(), fawkes::Interface::create_message(), disconnect(), fawkes::Message::fields(), fawkes::Interface::fields(), fawkes::Message::fields_end(), fawkes::Interface::fields_end(), fawkes::InterfaceFieldIterator::get_bool(), fawkes::InterfaceFieldIterator::get_byte(), fawkes::InterfaceFieldIterator::get_bytes(), fawkes::InterfaceFieldIterator::get_double(), fawkes::InterfaceFieldIterator::get_doubles(), fawkes::InterfaceFieldIterator::get_float(), fawkes::InterfaceFieldIterator::get_floats(), fawkes::InterfaceFieldIterator::get_int16(), fawkes::InterfaceFieldIterator::get_int32(), fawkes::InterfaceFieldIterator::get_int64(), fawkes::InterfaceFieldIterator::get_int8(), fawkes::InterfaceFieldIterator::get_length(), fawkes::InterfaceFieldIterator::get_name(), fawkes::InterfaceFieldIterator::get_string(), fawkes::InterfaceFieldIterator::get_type(), fawkes::InterfaceFieldIterator::get_typename(), fawkes::InterfaceFieldIterator::get_uint16(), fawkes::InterfaceFieldIterator::get_uint32(), fawkes::InterfaceFieldIterator::get_uint64(), fawkes::InterfaceFieldIterator::get_uint8(), fawkes::InterfaceFieldIterator::get_value_string(), fawkes::Message::id(), fawkes::IFT_BOOL, fawkes::IFT_BYTE, fawkes::IFT_DOUBLE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::IFT_INT16, fawkes::IFT_INT32, fawkes::IFT_INT64, fawkes::IFT_INT8, fawkes::IFT_STRING, fawkes::IFT_UINT16, fawkes::IFT_UINT32, fawkes::IFT_UINT64, fawkes::IFT_UINT8, instance(), interfaces(), fawkes::Interface::is_writer(), fawkes::Interface::msgq_empty(), fawkes::Interface::msgq_first(), fawkes::Interface::msgq_pop(), fawkes::BlackBoard::open_for_reading(), fawkes::BlackBoard::open_for_writing(), fawkes::Exception::print_trace(), fawkes::RefCount::ref(), fawkes::InterfaceFieldIterator::set_bool(), fawkes::InterfaceFieldIterator::set_float(), fawkes::InterfaceFieldIterator::set_int16(), fawkes::InterfaceFieldIterator::set_int32(), fawkes::InterfaceFieldIterator::set_int64(), fawkes::InterfaceFieldIterator::set_int8(), fawkes::InterfaceFieldIterator::set_string(), fawkes::InterfaceFieldIterator::set_uint16(), fawkes::InterfaceFieldIterator::set_uint32(), fawkes::InterfaceFieldIterator::set_uint64(), fawkes::InterfaceFieldIterator::set_uint8(), fawkes::Message::type(), fawkes::Interface::uid(), fawkes::RefCount::unref(), and fawkes::Exception::what_no_backtrace().

Referenced by interfaces().


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