iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nrt::BlackboardFederationSummaryListener Class Referenceabstract

#include <nrt/Core/Blackboard/BlackboardFederationSummaryListener.H>

Listener that will be triggered on each update of the Blackboard federation.

Definition at line 48 of file BlackboardFederationSummaryListener.H.

Inherited by NetworkCanvas.

Public Member Functions

 BlackboardFederationSummaryListener ()
 Constructor. More...
 
void activate ()
 Activate the listener (start listening) More...
 
void deactivate ()
 De-activate the listener (stop listening)
 
virtual ~BlackboardFederationSummaryListener ()
 Virtual destructor for safe inheritance. More...
 
virtual void update (std::shared_ptr< nrt::blackboard::BlackboardFederationSummary const > s)=0
 Callback function called each time a new BlackboardFederationSummary is available. More...
 

Constructor & Destructor Documentation

nrt::BlackboardFederationSummaryListener::BlackboardFederationSummaryListener ( )

Constructor.

After construction, the listener needs to be activated by calling activate(). This is not done during construction as objects that derive from BlackboardFederationSummaryListener and overload update() will not be fully constructed yet by the time the base class constructor is invoked, which would result in a pure virtual function called fatal error.

virtual nrt::BlackboardFederationSummaryListener::~BlackboardFederationSummaryListener ( )
virtual

Virtual destructor for safe inheritance.

Upon destruction, the listener will automatically un-register itself with the Blackboard federation and stop listening

Member Function Documentation

void nrt::BlackboardFederationSummaryListener::activate ( )

Activate the listener (start listening)

update() may be called immediately upon activation.

virtual void nrt::BlackboardFederationSummaryListener::update ( std::shared_ptr< nrt::blackboard::BlackboardFederationSummary const >  s)
pure virtual

Callback function called each time a new BlackboardFederationSummary is available.

Derived classes must overload this function and take the desired action upon BFS update.


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