ot::TCPSink Class Reference
[Network Classes]

#include <TCPSink.h>

Inheritance diagram for ot::TCPSink:

Inheritance graph
[legend]
Collaboration diagram for ot::TCPSink:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is a simple sink that stores a copy of all data passing through it and marks itself as changed for the TCPModule to process the new data. It also stores the protocol information necessary to send the right data.
Author:
Gerhard Reitmayr


Public Member Functions

virtual int isEventGenerator ()
virtual void onEventGenerated (Event &e, Node &generator)

Public Attributes

int station
 station number
int changed
 flag whether it was modified since last turn
Event event
 the event that is stored
int posFlag
 flags whether what to output
int orientFlag
int buttonFlag
int timeFlag

Protected Member Functions

 TCPSink (int number_, int pos_, int rot_, int but_, int time_)

Friends

class TCPModule


Constructor & Destructor Documentation

ot::TCPSink::TCPSink int  number_,
int  pos_,
int  rot_,
int  but_,
int  time_
[inline, protected]
 

constructor method,sets members

Parameters:
number_ the station number


Member Function Documentation

virtual int ot::TCPSink::isEventGenerator  )  [inline, virtual]
 

tests for EventGenerator interface being present. Is overriden to return 1 always.

Returns:
always 1

Reimplemented from ot::Node.

virtual void ot::TCPSink::onEventGenerated Event e,
Node generator
[inline, virtual]
 

this method notifies the object that a new event was generated. It stores a copy of the received event, marks itself as changed and passes the event on to its observers.

Parameters:
event reference to the new event. Do not change the event values, make a copy and change that !
generator reference to the EventGenerator object that notified the EventObserver.

Reimplemented from ot::Node.


Friends And Related Function Documentation

friend class TCPModule [friend]
 


Member Data Documentation

int ot::TCPSink::buttonFlag
 

int ot::TCPSink::changed
 

flag whether it was modified since last turn

Event ot::TCPSink::event
 

the event that is stored

int ot::TCPSink::orientFlag
 

int ot::TCPSink::posFlag
 

flags whether what to output

int ot::TCPSink::station
 

station number

int ot::TCPSink::timeFlag
 


The documentation for this class was generated from the following file:
Generated on Wed Feb 28 15:33:48 2007 for NaviTrack by  doxygen 1.4.6