User Manual, Developers Guide and API Documentation

wimac::frame::DataCollector Class Reference

The DataCollector provides a common frame for user data scheduler.

#include <frame/DataCollector.hpp>

Inheritance diagram for wimac::frame::DataCollector:

Inheritance graph
[legend]
Collaboration diagram for wimac::frame::DataCollector:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 DataCollector (const DataCollector &rhs)
 DataCollector (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &view)
void deliverReceived ()
bool doIsAccepting (const wns::ldk::CompoundPtr &) const
void doOnData (const wns::ldk::CompoundPtr &)
void doSendData (const wns::ldk::CompoundPtr &)
void doStart (int)
void doStartCollection (int)
void finishCollection ()
 Triggers the CompoundCollector to resolve horiziontal dependencies.
wns::simulator::Time getCurrentDuration () const
 Returns the duration of all collected compounds so far.
wimac::scheduler::InterfacegetRxScheduler () const
wimac::scheduler::InterfacegetTxScheduler () const
void onFUNCreated ()
 Resolve inter-FU dependencies.
void onTimeout ()
 Your callback. Implement this.

Private Member Functions

wimac::scheduler::InterfacegetCurrentScheduler () const

Private Attributes

wns::events::scheduler::IEventPtr deliverReceivedEvent
wimac::scheduler::InterfaceotherTXScheduler
wimac::PhyUserphyUser_
std::auto_ptr
< wimac::scheduler::Interface
rxScheduler
std::auto_ptr
< wimac::scheduler::Interface
txScheduler


Detailed Description

Definition at line 45 of file DataCollector.hpp.


Constructor & Destructor Documentation

DataCollector::DataCollector ( wns::ldk::fun::FUN fun,
const wns::pyconfig::View view 
)

Definition at line 44 of file DataCollector.cpp.

DataCollector::DataCollector ( const DataCollector rhs  ) 

Definition at line 69 of file DataCollector.cpp.


Member Function Documentation

void DataCollector::deliverReceived (  ) 

Definition at line 175 of file DataCollector.cpp.

bool DataCollector::doIsAccepting ( const wns::ldk::CompoundPtr compound  )  const

Definition at line 254 of file DataCollector.cpp.

void DataCollector::doOnData ( const wns::ldk::CompoundPtr compound  ) 

Definition at line 130 of file DataCollector.cpp.

void DataCollector::doSendData ( const wns::ldk::CompoundPtr compound  ) 

Definition at line 215 of file DataCollector.cpp.

void DataCollector::doStart ( int  mode  )  [virtual]

Implements wns::ldk::fcf::CompoundCollector.

Definition at line 238 of file DataCollector.cpp.

void DataCollector::doStartCollection ( int   )  [virtual]

Implements wns::ldk::fcf::CompoundCollector.

Definition at line 226 of file DataCollector.cpp.

void DataCollector::finishCollection (  )  [virtual]

Implements wns::ldk::fcf::CompoundCollectorInterface.

Definition at line 267 of file DataCollector.cpp.

wns::simulator::Time DataCollector::getCurrentDuration (  )  const [virtual]

Sometimes CompoundCollectors need to know how much time is still free for their phase. The FrameBuilder asks all CompoundCollectors how much time is already used by the CompoundCollectors. The minimum duration is the duration hint of the PhaseDescriptor.

Implements wns::ldk::fcf::CompoundCollectorInterface.

Definition at line 248 of file DataCollector.cpp.

wimac::scheduler::Interface * DataCollector::getCurrentScheduler (  )  const [private]

Definition at line 276 of file DataCollector.cpp.

wimac::scheduler::Interface* wimac::frame::DataCollector::getRxScheduler (  )  const [inline]

Definition at line 78 of file DataCollector.hpp.

wimac::scheduler::Interface* wimac::frame::DataCollector::getTxScheduler (  )  const [inline]

Definition at line 73 of file DataCollector.hpp.

void DataCollector::onFUNCreated (  )  [virtual]

Often FunctionalUnits require the collaboration with other FunctionalUnits to accomplish their task. For the collaboration between FunctionalUnits we coined the term "friendship".

The onFUNCreated method is a hook being called after the complete FUN has been set up. FunctionalUnits requiring the collaboration with other FunctionalUnits should resolve these dependencies by implementing this hook accordingly.

Finding friends is usually done calling wns::ldk::fun::FUN::findFriend.

When building reconfigurable FUNs, this method may get called multiple times (e.g., after each FUN reconfiguration). Keep that in mind when allocating resources in your onFUNCreated implementation.

Reimplemented from wns::ldk::FunctionalUnit.

Definition at line 98 of file DataCollector.cpp.

void DataCollector::onTimeout (  )  [virtual]

The deriver is forced to implement this method. It gets called, whenever the timer fires.

Implements wns::events::CanTimeout.

Definition at line 261 of file DataCollector.cpp.


Member Data Documentation

Definition at line 91 of file DataCollector.hpp.

Definition at line 99 of file DataCollector.hpp.

Definition at line 96 of file DataCollector.hpp.

Definition at line 94 of file DataCollector.hpp.

Definition at line 93 of file DataCollector.hpp.


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

Generated on Fri Feb 10 03:33:43 2012 for openWNS by  doxygen 1.5.5