Fawkes API Fawkes Development Version
BlackboardListenerThread::Event Class Referenceabstract

Abstract superclass for blackboard events. More...

#include <blackboard_listener_thread.h>

Inheritance diagram for BlackboardListenerThread::Event:

Public Member Functions

 Event (const std::string &type, const std::string &id)
 Constructor. More...
 
virtual operator EC_word ()=0
 Return an eclipse term representing the event (abstract) More...
 
std::string uid ()
 Return the UID (i.e. More...
 

Protected Attributes

string type
 Triggering interface's type name. More...
 
string id
 Triggering interface's ID. More...
 

Detailed Description

Abstract superclass for blackboard events.

Definition at line 71 of file blackboard_listener_thread.h.

Constructor & Destructor Documentation

◆ Event()

BlackboardListenerThread::Event::Event ( const std::string &  type,
const std::string &  id 
)
inline

Constructor.

Parameters
typeBlackboard interface type as string
idBlackboard interface ID

Definition at line 78 of file blackboard_listener_thread.h.

Member Function Documentation

◆ operator EC_word()

virtual BlackboardListenerThread::Event::operator EC_word ( )
pure virtual

Return an eclipse term representing the event (abstract)

Returns
An eclipse term representing the event (abstract)

Implemented in BlackboardListenerThread::Created, BlackboardListenerThread::Destroyed, and BlackboardListenerThread::Changed.

◆ uid()

std::string BlackboardListenerThread::Event::uid ( )
inline

Return the UID (i.e.

type::id) of the blackboard interface that triggered the event

Returns
The UID (i.e. type::id) of the blackboard interface that triggered the event

Definition at line 93 of file blackboard_listener_thread.h.

References id, and type.

Member Data Documentation

◆ id

string BlackboardListenerThread::Event::id
protected

Triggering interface's ID.

Definition at line 103 of file blackboard_listener_thread.h.

Referenced by uid().

◆ type

string BlackboardListenerThread::Event::type
protected

Triggering interface's type name.

Definition at line 100 of file blackboard_listener_thread.h.

Referenced by uid().


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