NewDatumNotifiable< DataType_t > Class Template Referenceabstract

The interface for classes that want to be notified when a new datum is available. More...

Inheritance diagram for NewDatumNotifiable< DataType_t >:

Public Types

typedef DataType_t DataType
 The type of data being exchanged. More...
 

Public Member Functions

virtual ~NewDatumNotifiable ()
 Destructor. More...
 
virtual void newDatumAvailable (DataDownloader< DataType > *downloader)=0
 The function called when a new datum is available. More...
 

Detailed Description

template<class DataType_t>
class farsa::NewDatumNotifiable< DataType_t >

The interface for classes that want to be notified when a new datum is available.

Definition at line 638 of file dataexchange.h.

Member Typedef Documentation

typedef DataType_t DataType

The type of data being exchanged.

Definition at line 644 of file dataexchange.h.

Constructor & Destructor Documentation

virtual ~NewDatumNotifiable ( )
inlinevirtual

Destructor.

Definition at line 650 of file dataexchange.h.

Member Function Documentation

virtual void newDatumAvailable ( DataDownloader< DataType > *  downloader)
pure virtual

The function called when a new datum is available.

This function is called when a new datum is available.

Parameters
downloaderthe downloader with the available datum
Note
This should be thread-safe, as the notification arrives from the thread where the uploader lives

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