wimac::frame::DLMapCollector Class Reference

The sending entity of the DL MAP.

#include <frame/DLMapCollector.hpp>

Inheritance diagram for wimac::frame::DLMapCollector:

[legend]

Collaboration diagram for wimac::frame::DLMapCollector:

[legend]

List of all members.

Public Member Functions
void	calculateSizes (const wns::ldk::CommandPool *commandPool, Bit &commandPoolSize, Bit &dataSize) const
	Default calculateSizes implementation.
	DLMapCollector (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &config)
void	doOnData (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.
wns::simulator::Time	getDLPhaseDuration () const
	Returns the duration of the DL phase.
virtual wns::scheduler::SchedulingMapPtr	getMasterMapForSlaveScheduling ()
void	onFUNCreated ()
	Resolve inter-FU dependencies.
void	onTimeout ()
	Your callback. Implement this.
virtual bool	resourcesGranted ()
Private Attributes
wimac::Component *	component_
wimac::service::ConnectionManager *	connectionManager_
wns::simulator::Time	dlPhaseDuration_
wimac::scheduler::Scheduler *	dlScheduler_
std::string	dlSchedulerName_
wns::SmartPtr< const wns::service::phy::phymode::PhyModeInterface >	phyMode
wimac::PhyUser *	phyUser_

---

Detailed Description

Definition at line 57 of file DLMapCollector.hpp.

---

Constructor & Destructor Documentation

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

Definition at line 50 of file DLMapCollector.cpp.

---

Member Function Documentation

void DLMapCollector::calculateSizes	(	const wns::ldk::CommandPool *	commandPool,
		Bit &	commandPoolSize,
		Bit &	dataSize
	)			const [virtual]

The default implementation delegates calculation to upper functional units, modifying the result to include the size of the provided Command.

Reimplemented from wns::ldk::CommandTypeSpecifier< T >.

Definition at line 150 of file DLMapCollector.cpp.

void DLMapCollector::doOnData

(

const wns::ldk::CompoundPtr &

compound

)

Definition at line 181 of file DLMapCollector.cpp.

void DLMapCollector::doStart

(

int

mode

)

[virtual]

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

Definition at line 87 of file DLMapCollector.cpp.

void wimac::frame::DLMapCollector::doStartCollection

(

int

)

[inline, virtual]

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

Definition at line 92 of file DLMapCollector.hpp.

void wimac::frame::DLMapCollector::finishCollection

(

)

[inline, virtual]

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

Definition at line 93 of file DLMapCollector.hpp.

wns::simulator::Time DLMapCollector::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 166 of file DLMapCollector.cpp.

wns::simulator::Time wimac::frame::DLMapCollector::getDLPhaseDuration

(

)

const [inline]

This method is only usefull in the receiving MapCollector.

Definition at line 105 of file DLMapCollector.hpp.

virtual wns::scheduler::SchedulingMapPtr wimac::frame::DLMapCollector::getMasterMapForSlaveScheduling

(

)

[inline, virtual]

Implements wimac::frame::MapHandlerInterface.

Definition at line 75 of file DLMapCollector.hpp.

void DLMapCollector::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 63 of file DLMapCollector.cpp.

void DLMapCollector::onTimeout

(

)

[virtual]

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

Implements wns::events::CanTimeout.

Definition at line 161 of file DLMapCollector.cpp.

virtual bool wimac::frame::DLMapCollector::resourcesGranted

(

)

[inline, virtual]

Implements wimac::frame::MapHandlerInterface.

Definition at line 70 of file DLMapCollector.hpp.

---

Member Data Documentation

wimac::Component* wimac::frame::DLMapCollector::component_ [private]

Definition at line 110 of file DLMapCollector.hpp.

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

Definition at line 115 of file DLMapCollector.hpp.

wns::simulator::Time wimac::frame::DLMapCollector::dlPhaseDuration_ [private]

Definition at line 116 of file DLMapCollector.hpp.

wimac::scheduler::Scheduler* wimac::frame::DLMapCollector::dlScheduler_ [private]

Definition at line 108 of file DLMapCollector.hpp.

std::string wimac::frame::DLMapCollector::dlSchedulerName_ [private]

Definition at line 109 of file DLMapCollector.hpp.

wns::SmartPtr<const wns::service::phy::phymode::PhyModeInterface> wimac::frame::DLMapCollector::phyMode [private]

Definition at line 112 of file DLMapCollector.hpp.

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

Definition at line 111 of file DLMapCollector.hpp.

---

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

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