Fawkes API Fawkes Development Version

RefBoxProcessor Class Reference

Referee Box Communication Processor. More...

#include "processor/processor.h"

Inheritance diagram for RefBoxProcessor:

List of all members.

Public Member Functions

virtual ~RefBoxProcessor ()
 Pure virtual destructor.
virtual bool check_connection ()=0
 Check if the connection is alive and reconnect.
virtual void refbox_process ()=0
 Process incoming refbox communication.
virtual void set_handler (RefBoxStateHandler *rsh)
 Set handler.

Protected Attributes

RefBoxStateHandler_rsh
 Refbox state handler, set via set_handler()

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 28 of file processor.h.


Constructor & Destructor Documentation

RefBoxProcessor::~RefBoxProcessor ( ) [virtual]

Pure virtual destructor.

Definition at line 45 of file processor.cpp.


Member Function Documentation

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 Msl2010RefBoxProcessor, RemoteBlackBoardRefBoxProcessor, and SplRefBoxProcessor.

Referenced by RefBoxCommThread::loop().

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 Msl2010RefBoxProcessor, RemoteBlackBoardRefBoxProcessor, and SplRefBoxProcessor.

Referenced by RefBoxCommThread::loop().

void RefBoxProcessor::set_handler ( RefBoxStateHandler rsh) [virtual]

Set handler.

Parameters:
rshRef box state handler used to process incoming information

Definition at line 53 of file processor.cpp.

References _rsh.

Referenced by RefBoxCommThread::init().


Member Data Documentation

Refbox state handler, set via set_handler()

Definition at line 40 of file processor.h.

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends