wimac::frame::FrameHeadCollector Class Reference

The CompoundCollector for frame control headers.

#include <frame/FrameHeadCollector.hpp>

Inheritance diagram for wimac::frame::FrameHeadCollector:

[legend]

Collaboration diagram for wimac::frame::FrameHeadCollector:

[legend]

List of all members.

Public Member Functions
void	doOnData (const wns::ldk::CompoundPtr &)
void	doStart (int)
void	doStartCollection (int)
void	finishCollection ()
	Triggers the CompoundCollector to resolve horiziontal dependencies.
	FrameHeadCollector (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &config)
virtual wns::simulator::Time	getCurrentDuration () const
	Returns the duration of all collected compounds so far.
void	onFUNCreated ()
	Resolve inter-FU dependencies.
void	onTimeout ()
	Your callback. Implement this.
Private Attributes
wimac::service::IChannelQualityObserver *	channelQualityObserver_
wimac::service::ConnectionManager *	connectionManager_
wimac::Component *	layer_
wns::SmartPtr< const wns::service::phy::phymode::PhyModeInterface >	phyMode_
wimac::PhyUser *	phyUser_

---

Detailed Description

Definition at line 69 of file FrameHeadCollector.hpp.

---

Constructor & Destructor Documentation

FrameHeadCollector::FrameHeadCollector	(	wns::ldk::fun::FUN *	fun,
		const wns::pyconfig::View &	config
	)

Definition at line 46 of file FrameHeadCollector.cpp.

---

Member Function Documentation

void FrameHeadCollector::doOnData

(

const wns::ldk::CompoundPtr &

compound

)

Definition at line 133 of file FrameHeadCollector.cpp.

void FrameHeadCollector::doStart

(

int

mode

)

[virtual]

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

Definition at line 76 of file FrameHeadCollector.cpp.

void wimac::frame::FrameHeadCollector::doStartCollection

(

int

)

[inline, virtual]

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

Definition at line 87 of file FrameHeadCollector.hpp.

void wimac::frame::FrameHeadCollector::finishCollection

(

)

[inline, virtual]

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

Definition at line 88 of file FrameHeadCollector.hpp.

virtual wns::simulator::Time wimac::frame::FrameHeadCollector::getCurrentDuration

(

)

const [inline, 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 90 of file FrameHeadCollector.hpp.

void FrameHeadCollector::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 55 of file FrameHeadCollector.cpp.

void FrameHeadCollector::onTimeout

(

)

[virtual]

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

Implements wns::events::CanTimeout.

Definition at line 127 of file FrameHeadCollector.cpp.

---

Member Data Documentation

wimac::service::IChannelQualityObserver* wimac::frame::FrameHeadCollector::channelQualityObserver_ [private]

Definition at line 101 of file FrameHeadCollector.hpp.

wimac::service::ConnectionManager* wimac::frame::FrameHeadCollector::connectionManager_ [private]

Definition at line 100 of file FrameHeadCollector.hpp.

wimac::Component* wimac::frame::FrameHeadCollector::layer_ [private]

Definition at line 98 of file FrameHeadCollector.hpp.

wns::SmartPtr<const wns::service::phy::phymode::PhyModeInterface> wimac::frame::FrameHeadCollector::phyMode_ [private]

Definition at line 102 of file FrameHeadCollector.hpp.

wimac::PhyUser* wimac::frame::FrameHeadCollector::phyUser_ [private]

Definition at line 99 of file FrameHeadCollector.hpp.

---

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

• modules/dll/wimac/src/frame/FrameHeadCollector.hpp
• modules/dll/wimac/src/frame/FrameHeadCollector.cpp