Fawkes API
Fawkes Development Version
|
Interface mediator interface. More...
#include <interface_mediator.h>
Public Member Functions | |
virtual | ~InterfaceMediator () |
Virtual destructor. More... | |
virtual bool | exists_writer (const Interface *interface) const =0 |
Check if a writer exists for the given interface. More... | |
virtual unsigned int | num_readers (const Interface *interface) const =0 |
Get number of readers. More... | |
virtual std::list< std::string > | readers (const Interface *interface) const =0 |
Get owners of interfaces who opened for reading. More... | |
virtual std::string | writer (const Interface *interface) const =0 |
Get writer of interface. More... | |
virtual void | notify_of_data_refresh (const Interface *interface, bool has_changed)=0 |
Notify of data change. More... | |
Interface mediator interface.
An interface mediator is used by interfaces to communicate events and to query status information which need interaction with the BlackBoard.
Definition at line 39 of file interface_mediator.h.
|
inlinevirtual |
Virtual destructor.
Definition at line 43 of file interface_mediator.h.
|
pure virtual |
Check if a writer exists for the given interface.
interface | interface to check |
Implemented in fawkes::BlackBoardInterfaceProxy, and fawkes::BlackBoardInterfaceManager.
Referenced by fawkes::Interface::has_writer().
|
pure virtual |
Notify of data change.
Notify all subscribers of the given interface of a data change. This also influences logging and sending data over the network so it is mandatory to call this function! The interface base class write method does that for you.
interface | interface whose subscribers to notify |
has_changed | whether the current data is different from the last time write() was called on the interface |
Implemented in fawkes::BlackBoardInterfaceProxy, and fawkes::BlackBoardInterfaceManager.
Referenced by fawkes::Interface::write().
|
pure virtual |
Get number of readers.
Get the number of readers that the given interface has.
interface | interface to check |
Implemented in fawkes::BlackBoardInterfaceProxy, and fawkes::BlackBoardInterfaceManager.
Referenced by fawkes::Interface::num_readers().
|
pure virtual |
Get owners of interfaces who opened for reading.
interface | an interface to query for the UID |
Implemented in fawkes::BlackBoardInterfaceProxy, and fawkes::BlackBoardInterfaceManager.
Referenced by fawkes::Interface::readers().
|
pure virtual |
Get writer of interface.
interface | an interface to query for the UID |
Implemented in fawkes::BlackBoardInterfaceProxy, and fawkes::BlackBoardInterfaceManager.
Referenced by fawkes::Interface::writer().