Fawkes API
Fawkes Development Version
|
An interface adapter using standard POSIX time facilities to implement LookupNow and LookupOnChange. More...
#include <blackboard_adapter.h>
Public Member Functions | |
BlackboardPlexilAdapter (PLEXIL::AdapterExecInterface &execInterface) | |
Constructor. More... | |
BlackboardPlexilAdapter (PLEXIL::AdapterExecInterface &execInterface, pugi::xml_node const xml) | |
Constructor from configuration XML. More... | |
virtual | ~BlackboardPlexilAdapter () |
Destructor. More... | |
virtual bool | initialize () |
Initialize adapter. More... | |
virtual bool | start () |
Start adapter. More... | |
virtual bool | stop () |
Stop adapter. More... | |
virtual bool | reset () |
Reset adapter. More... | |
virtual bool | shutdown () |
Shut adapter down. More... | |
virtual void | lookupNow (PLEXIL::State const &state, PLEXIL::StateCacheEntry &cacheEntry) |
Immediate lookup of value. More... | |
virtual void | subscribe (const PLEXIL::State &state) |
Subscribe to updates for given state. More... | |
virtual void | unsubscribe (const PLEXIL::State &state) |
Unsubscribe from updates. More... | |
virtual void | executeCommand (PLEXIL::Command *cmd) |
Perform given command. More... | |
![]() | |
BlackBoardInterfaceListener (const char *name_format,...) | |
Constructor. More... | |
virtual | ~BlackBoardInterfaceListener () |
Destructor. More... | |
const char * | bbil_name () const |
Get BBIL name. More... | |
virtual bool | bb_interface_message_received (Interface *interface, Message *message) throw () |
BlackBoard message received notification. More... | |
virtual void | bb_interface_writer_added (Interface *interface, unsigned int instance_serial) throw () |
A writing instance has been opened for a watched interface. More... | |
virtual void | bb_interface_writer_removed (Interface *interface, unsigned int instance_serial) throw () |
A writing instance has been closed for a watched interface. More... | |
virtual void | bb_interface_reader_added (Interface *interface, unsigned int instance_serial) throw () |
A reading instance has been opened for a watched interface. More... | |
virtual void | bb_interface_reader_removed (Interface *interface, unsigned int instance_serial) throw () |
A reading instance has been closed for a watched interface. More... | |
Additional Inherited Members | |
![]() | |
enum | QueueEntryType { DATA = 0, MESSAGES = 1, READER = 2, WRITER = 3 } |
Queue entry type. More... | |
typedef std::list< QueueEntry > | InterfaceQueue |
Queue of additions/removal of interfaces. More... | |
typedef std::map< std::string, Interface * > | InterfaceMap |
Map of currently active event subscriptions. More... | |
![]() | |
void | bbil_add_data_interface (Interface *interface) |
Add an interface to the data modification watch list. More... | |
void | bbil_add_message_interface (Interface *interface) |
Add an interface to the message received watch list. More... | |
void | bbil_add_reader_interface (Interface *interface) |
Add an interface to the reader addition/removal watch list. More... | |
void | bbil_add_writer_interface (Interface *interface) |
Add an interface to the writer addition/removal watch list. More... | |
void | bbil_remove_data_interface (Interface *interface) |
Remove an interface to the data modification watch list. More... | |
void | bbil_remove_message_interface (Interface *interface) |
Remove an interface to the message received watch list. More... | |
void | bbil_remove_reader_interface (Interface *interface) |
Remove an interface to the reader addition/removal watch list. More... | |
void | bbil_remove_writer_interface (Interface *interface) |
Remove an interface to the writer addition/removal watch list. More... | |
Interface * | bbil_data_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Interface * | bbil_message_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Interface * | bbil_reader_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
Interface * | bbil_writer_interface (const char *iuid) throw () |
Get interface instance for given UID. More... | |
An interface adapter using standard POSIX time facilities to implement LookupNow and LookupOnChange.
Plexil adapter to provide access to Fawkes blackboard
Definition at line 44 of file blackboard_adapter.h.
BlackboardPlexilAdapter::BlackboardPlexilAdapter | ( | PLEXIL::AdapterExecInterface & | execInterface | ) |
Constructor.
execInterface | Reference to the parent AdapterExecInterface object. |
Definition at line 49 of file blackboard_adapter.cpp.
BlackboardPlexilAdapter::BlackboardPlexilAdapter | ( | PLEXIL::AdapterExecInterface & | execInterface, |
pugi::xml_node const | xml | ||
) |
Constructor from configuration XML.
execInterface | Reference to the parent AdapterExecInterface object. |
xml | A const reference to the XML element describing this adapter |
Definition at line 59 of file blackboard_adapter.cpp.
|
virtual |
Destructor.
Definition at line 66 of file blackboard_adapter.cpp.
|
virtual |
Perform given command.
cmd | command to execute |
Definition at line 439 of file blackboard_adapter.cpp.
|
virtual |
Initialize adapter.
Definition at line 74 of file blackboard_adapter.cpp.
References fawkes::BlackBoard::register_listener().
|
virtual |
Immediate lookup of value.
state | state variable to lookup |
cache_entry | cache entry for retrieved value |
Definition at line 160 of file blackboard_adapter.cpp.
References fawkes::Logger::log_warn().
|
virtual |
Reset adapter.
Definition at line 133 of file blackboard_adapter.cpp.
|
virtual |
Shut adapter down.
Definition at line 142 of file blackboard_adapter.cpp.
References fawkes::BlackBoard::close(), and fawkes::BlackBoard::unregister_listener().
|
virtual |
Start adapter.
Definition at line 115 of file blackboard_adapter.cpp.
|
virtual |
Stop adapter.
Definition at line 124 of file blackboard_adapter.cpp.
|
virtual |
Subscribe to updates for given state.
state | state variable to subscribe for |
Definition at line 347 of file blackboard_adapter.cpp.
References fawkes::BlackBoardInterfaceListener::bbil_add_data_interface(), fawkes::Logger::log_error(), fawkes::Logger::log_warn(), and fawkes::BlackBoard::update_listener().
|
virtual |
Unsubscribe from updates.
state | state variable to unsubscribe from |
Definition at line 379 of file blackboard_adapter.cpp.
References fawkes::BlackBoardInterfaceListener::bbil_remove_data_interface(), fawkes::Logger::log_error(), fawkes::Logger::log_warn(), and fawkes::BlackBoard::update_listener().