User Manual, Developers Guide and API Documentation

copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE > Class Template Reference

Signale the end of transmission for the different transmission types (broadcast, unicast).

Inheritance diagram for copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >:

Inheritance graph
[legend]
Collaboration diagram for copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual TransmissionPtr getTransmission () const
 Retuns the according transmission.
void operator() ()
 Called by EventScheduler on execution of this event.
 TransmissionEndEvent (Wire *w, const TRANSMISSIONTYPE &t)
 Constructor.

Private Attributes

TRANSMISSIONTYPE transmission
 The transmission itself.
Wirewire
 The wire on which the transmission took place.


Detailed Description

template<typename TRANSMISSIONTYPE>
class copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >

Definition at line 191 of file Wire.hpp.


Constructor & Destructor Documentation

template<typename TRANSMISSIONTYPE>
copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >::TransmissionEndEvent ( Wire w,
const TRANSMISSIONTYPE &  t 
) [inline]

Parameters:
Wire 

Definition at line 200 of file Wire.hpp.


Member Function Documentation

template<typename TRANSMISSIONTYPE>
virtual TransmissionPtr copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >::getTransmission (  )  const [inline, virtual]

Implements copper::Wire::TransmissionEndEventBase.

Definition at line 222 of file Wire.hpp.

template<typename TRANSMISSIONTYPE>
void copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >::operator() (  )  [inline]

Definition at line 213 of file Wire.hpp.


Member Data Documentation

template<typename TRANSMISSIONTYPE>
TRANSMISSIONTYPE copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >::transmission [private]

Note:
The transmission is stored with its real type (this is why this class is a template) not its base class TransmissionPtr. This way the method wire->stopTransmission(transmission) can call two different methods according to the type of "transmission" because they are overload in "Wire". This makes the processing, which is different for Broadcast and Unicast transmission much easier.

Definition at line 245 of file Wire.hpp.

template<typename TRANSMISSIONTYPE>
Wire* copper::Wire::TransmissionEndEvent< TRANSMISSIONTYPE >::wire [private]

Definition at line 231 of file Wire.hpp.


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