User Manual, Developers Guide and API Documentation

copper::ReceiverInterface Class Reference

Interface used by Wire to inform the Receiver. More...

#include <ReceiverInterface.hpp>

Inheritance diagram for copper::ReceiverInterface:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void onCollision ()=0
 Called, if a collision occured.
virtual void onCopperBusy ()=0
 Called, if the wire got busy.
virtual void onCopperFree ()=0
 Called, if the wire got free.
virtual bool onData (const BroadcastTransmissionPtr &transmission)=0
 Data (broadcast) for this receiver arrived.
virtual bool onData (const UnicastTransmissionPtr &transmission)=0
 Data (unicast) for this receiver arrived.
virtual ~ReceiverInterface ()
 Destructor.


Detailed Description

This is interface is used by the wire in order to notify the Receiver of transmission events

Definition at line 39 of file ReceiverInterface.hpp.


Constructor & Destructor Documentation

virtual copper::ReceiverInterface::~ReceiverInterface (  )  [inline, virtual]

Definition at line 46 of file ReceiverInterface.hpp.


Member Function Documentation

virtual void copper::ReceiverInterface::onCollision (  )  [pure virtual]

Implemented in copper::Receiver.

virtual void copper::ReceiverInterface::onCopperBusy (  )  [pure virtual]

Implemented in copper::Receiver.

virtual void copper::ReceiverInterface::onCopperFree (  )  [pure virtual]

Implemented in copper::Receiver.

virtual bool copper::ReceiverInterface::onData ( const BroadcastTransmissionPtr transmission  )  [pure virtual]

Each receiver implementation will need to check if the packet is good or bad. The current BER is also determined by the receiver. This leaves as much room for the implementation as possible.

Implemented in copper::Receiver, and copper::Receiver.

virtual bool copper::ReceiverInterface::onData ( const UnicastTransmissionPtr transmission  )  [pure virtual]

Each receiver implementation will need to check if the packet is good or bad. The current BER is also determined by the receiver. This leaves as much room for the implementation as possible.

Implemented in copper::Receiver, and copper::Receiver.


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

Generated on Sat May 26 03:32:29 2012 for openWNS by  doxygen 1.5.5