Fawkes API  Fawkes Development Version
RefBoxProcessor Class Referenceabstract

#include "processor/processor.h"

Inheritance diagram for RefBoxProcessor:

Public Member Functions

virtual ~RefBoxProcessor ()
 Pure virtual destructor. More...
 
virtual bool check_connection ()=0
 
virtual void refbox_process ()=0
 
virtual void set_handler (RefBoxStateHandler *rsh)
 Set handler. More...
 

Protected Attributes

RefBoxStateHandler_rsh
 Refbox state handler, set via set_handler() More...
 

Detailed Description

Referee Box Communication Processor. Classes that implement this interface communicate with a refbox and provide information received to a RefBoxStateHandler.

Author
Tim Niemueller

Definition at line 27 of file processor.h.

Constructor & Destructor Documentation

◆ ~RefBoxProcessor()

RefBoxProcessor::~RefBoxProcessor ( )
virtual

Pure virtual destructor.

Definition at line 44 of file processor.cpp.

Member Function Documentation

◆ check_connection()

bool RefBoxProcessor::check_connection ( )
pure virtual

Check if the connection is alive and reconnect. If the connection is not alive the processor shall do a single attempt to reestablish the connection.

Returns
true if the connection is established or could be recovered, false otherwise.

Implemented in SplRefBoxProcessor, Msl2010RefBoxProcessor, and RemoteBlackBoardRefBoxProcessor.

Referenced by RefBoxCommThread::loop().

◆ refbox_process()

void RefBoxProcessor::refbox_process ( )
pure virtual

Process incoming refbox communication. This shall process a (limited number of) communication packets received from the particular refbox at hand.

Implemented in SplRefBoxProcessor, Msl2010RefBoxProcessor, and RemoteBlackBoardRefBoxProcessor.

Referenced by RefBoxCommThread::loop().

◆ set_handler()

void RefBoxProcessor::set_handler ( RefBoxStateHandler rsh)
virtual

Set handler.

Parameters
rshRef box state handler used to process incoming information

Definition at line 52 of file processor.cpp.

References _rsh.

Referenced by RefBoxCommThread::init().

Member Data Documentation

◆ _rsh

RefBoxStateHandler* RefBoxProcessor::_rsh
protected

Refbox state handler, set via set_handler()

Definition at line 39 of file processor.h.

Referenced by RemoteBlackBoardRefBoxProcessor::refbox_process(), and set_handler().


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