fawkes::InterfaceMediator Class Reference
Interface mediator interface. More...
#include <interface_mediator.h>

Public Member Functions | |
| virtual | ~InterfaceMediator () |
| Virtual destructor. | |
| virtual bool | exists_writer (const Interface *interface) const =0 |
| Check if a writer exists for the given interface. | |
| virtual unsigned int | num_readers (const Interface *interface) const =0 |
| Get number of readers. | |
| virtual void | notify_of_data_change (const Interface *interface)=0 |
| Notify of data change. | |
Detailed Description
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 36 of file interface_mediator.h.
Constructor & Destructor Documentation
| virtual fawkes::InterfaceMediator::~InterfaceMediator | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual bool fawkes::InterfaceMediator::exists_writer | ( | const Interface * | interface | ) | const [pure virtual] |
Check if a writer exists for the given interface.
- Parameters:
-
interface interface to check
- Returns:
- true, if there is any writer for the given interface, false otherwise
Implemented in fawkes::BlackBoardInterfaceManager, and fawkes::BlackBoardInterfaceProxy.
Referenced by fawkes::Interface::has_writer().
| virtual void fawkes::InterfaceMediator::notify_of_data_change | ( | const Interface * | interface | ) | [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.
- Parameters:
-
interface interface whose subscribers to notify
- See also:
- Interface::write()
Implemented in fawkes::BlackBoardInterfaceManager, and fawkes::BlackBoardInterfaceProxy.
Referenced by fawkes::Interface::write().
| virtual unsigned int fawkes::InterfaceMediator::num_readers | ( | const Interface * | interface | ) | const [pure virtual] |
Get number of readers.
Get the number of readers that the given interface has.
- Parameters:
-
interface interface to check
- Returns:
- number of readers currently registered for the given interface.
Implemented in fawkes::BlackBoardInterfaceManager, and fawkes::BlackBoardInterfaceProxy.
Referenced by fawkes::Interface::num_readers().
The documentation for this class was generated from the following file:
- src/libs/interface/mediators/interface_mediator.h

