wimac::frame::ULMapCollector Class Reference

Sending entity for the ULMapCommand.

#include <frame/ULMapCollector.hpp>

Inheritance diagram for wimac::frame::ULMapCollector:

Collaboration diagram for wimac::frame::ULMapCollector:

List of all members.

Public Member Functions

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

Default calculateSizes implementation.

void doOnData (const wns::ldk::CompoundPtr &)

void doStart (int)

void doStartCollection (int)

void finishCollection ()

Triggers the CompoundCollector to resolve horiziontal dependencies.

wns::simulator::Time getBurstEnd () const

Returns the end of the subscriber station's burst relative to ULPhase start time.

wns::scheduler::MapInfoCollectionPtr getBursts ()

wns::simulator::Time getBurstStart () const

Returns the start of the subscriber station's burst relative to ULPhase start time.

wns::simulator::Time getCurrentDuration () const

Returns the duration of all collected compounds so far.

wns::scheduler::ChannelQualityOnOneSubChannel getEstimatedCQI () const

virtual
wns::scheduler::SchedulingMapPtr getMasterMapForSlaveScheduling ()

wns::SmartPtr< const
wns::service::phy::phymode::PhyModeInterface > getPhyMode () const

wns::simulator::Time getULPhaseDuration () const

bool hasUplinkBurst () const

void onFUNCreated ()

Resolve inter-FU dependencies.

void onTimeout ()

Your callback. Implement this.

bool resourcesGranted ()

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

Private Attributes

wns::simulator::Time burstEndTime_

wns::SmartPtr< const
wns::service::phy::phymode::PhyModeInterface > burstPhyMode

wns::simulator::Time burstStartTime_

wimac::Component * component_

wimac::service::ConnectionManager * connectionManager_

wns::scheduler::ChannelQualityOnOneSubChannel estimatedCQI_

bool hasUplinkBurst_

wns::scheduler::UserID me_

wns::scheduler::MapInfoCollectionPtr myBursts_

wns::SmartPtr< const
wns::service::phy::phymode::PhyModeInterface > phyMode

PhyMode to be used for the MAP.

wimac::PhyUser * phyUser_

wns::scheduler::SchedulingMapPtr scheduledULMap_

wns::simulator::Time ulPhaseDuration_

bool ulResourcesAvailable_

PhyMode to be used for the burst.

wimac::scheduler::Scheduler * ulScheduler_

std::string ulSchedulerName_

Detailed Description

Definition at line 77 of file ULMapCollector.hpp.

Constructor & Destructor Documentation

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

Definition at line 60 of file ULMapCollector.cpp.

Member Function Documentation

void ULMapCollector::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 169 of file ULMapCollector.cpp.

void ULMapCollector::doOnData ( const wns::ldk::CompoundPtr & compound )

Definition at line 194 of file ULMapCollector.cpp.

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

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

Definition at line 106 of file ULMapCollector.cpp.

void wimac::frame::ULMapCollector::doStartCollection ( int ) [inline, virtual]

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

Definition at line 99 of file ULMapCollector.hpp.

void wimac::frame::ULMapCollector::finishCollection ( ) [inline, virtual]

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

Definition at line 100 of file ULMapCollector.hpp.

wns::simulator::Time wimac::frame::ULMapCollector::getBurstEnd ( ) const [inline]

Definition at line 121 of file ULMapCollector.hpp.

wns::scheduler::MapInfoCollectionPtr wimac::frame::ULMapCollector::getBursts ( ) [inline]

Definition at line 138 of file ULMapCollector.hpp.

wns::simulator::Time wimac::frame::ULMapCollector::getBurstStart ( ) const [inline]

Definition at line 112 of file ULMapCollector.hpp.

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

wns::scheduler::ChannelQualityOnOneSubChannel wimac::frame::ULMapCollector::getEstimatedCQI ( ) const [inline, virtual]

Reimplemented from wimac::frame::MapHandlerInterface.

Definition at line 129 of file ULMapCollector.hpp.

virtual wns::scheduler::SchedulingMapPtr wimac::frame::ULMapCollector::getMasterMapForSlaveScheduling ( ) [inline, virtual]

Implements wimac::frame::MapHandlerInterface.

Definition at line 145 of file ULMapCollector.hpp.

wns::SmartPtr<const wns::service::phy::phymode::PhyModeInterface> wimac::frame::ULMapCollector::getPhyMode ( ) const [inline]

Definition at line 125 of file ULMapCollector.hpp.

wns::simulator::Time wimac::frame::ULMapCollector::getULPhaseDuration ( ) const [inline]

Definition at line 105 of file ULMapCollector.hpp.

bool wimac::frame::ULMapCollector::hasUplinkBurst ( ) const [inline]

Definition at line 133 of file ULMapCollector.hpp.

void ULMapCollector::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 79 of file ULMapCollector.cpp.

void ULMapCollector::onTimeout ( ) [virtual]

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

Implements wns::events::CanTimeout.

Definition at line 163 of file ULMapCollector.cpp.

bool wimac::frame::ULMapCollector::resourcesGranted ( ) [inline, virtual]

Implements wimac::frame::MapHandlerInterface.

Definition at line 141 of file ULMapCollector.hpp.

Member Data Documentation

wns::simulator::Time wimac::frame::ULMapCollector::burstEndTime_ [private]

Definition at line 165 of file ULMapCollector.hpp.

wns::SmartPtr<const wns::service::phy::phymode::PhyModeInterface> wimac::frame::ULMapCollector::burstPhyMode [private]

Definition at line 167 of file ULMapCollector.hpp.

wns::simulator::Time wimac::frame::ULMapCollector::burstStartTime_ [private]

Definition at line 164 of file ULMapCollector.hpp.

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

Definition at line 152 of file ULMapCollector.hpp.

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

Definition at line 154 of file ULMapCollector.hpp.

wns::scheduler::ChannelQualityOnOneSubChannel wimac::frame::ULMapCollector::estimatedCQI_ [private]

Definition at line 168 of file ULMapCollector.hpp.

bool wimac::frame::ULMapCollector::hasUplinkBurst_ [private]

Definition at line 169 of file ULMapCollector.hpp.

wns::scheduler::UserID wimac::frame::ULMapCollector::me_ [private]

Definition at line 179 of file ULMapCollector.hpp.

wns::scheduler::MapInfoCollectionPtr wimac::frame::ULMapCollector::myBursts_ [private]

Definition at line 166 of file ULMapCollector.hpp.

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

Definition at line 161 of file ULMapCollector.hpp.

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

Definition at line 153 of file ULMapCollector.hpp.

wns::scheduler::SchedulingMapPtr wimac::frame::ULMapCollector::scheduledULMap_ [private]

Definition at line 171 of file ULMapCollector.hpp.

wns::simulator::Time wimac::frame::ULMapCollector::ulPhaseDuration_ [private]

Definition at line 163 of file ULMapCollector.hpp.

bool wimac::frame::ULMapCollector::ulResourcesAvailable_ [private]

Definition at line 177 of file ULMapCollector.hpp.

wimac::scheduler::Scheduler* wimac::frame::ULMapCollector::ulScheduler_ [private]

Definition at line 150 of file ULMapCollector.hpp.

std::string wimac::frame::ULMapCollector::ulSchedulerName_ [private]

Definition at line 151 of file ULMapCollector.hpp.

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

modules/dll/wimac/src/frame/ULMapCollector.hpp
modules/dll/wimac/src/frame/ULMapCollector.cpp


Public Member Functions
void	calculateSizes (const wns::ldk::CommandPool *commandPool, Bit &commandPoolSize, Bit &dataSize) const
	Default calculateSizes implementation.
void	doOnData (const wns::ldk::CompoundPtr &)
void	doStart (int)
void	doStartCollection (int)
void	finishCollection ()
	Triggers the CompoundCollector to resolve horiziontal dependencies.
wns::simulator::Time	getBurstEnd () const
	Returns the end of the subscriber station's burst relative to ULPhase start time.
wns::scheduler::MapInfoCollectionPtr	getBursts ()
wns::simulator::Time	getBurstStart () const
	Returns the start of the subscriber station's burst relative to ULPhase start time.
wns::simulator::Time	getCurrentDuration () const
	Returns the duration of all collected compounds so far.
wns::scheduler::ChannelQualityOnOneSubChannel	getEstimatedCQI () const
virtual wns::scheduler::SchedulingMapPtr	getMasterMapForSlaveScheduling ()
wns::SmartPtr< const wns::service::phy::phymode::PhyModeInterface >	getPhyMode () const
wns::simulator::Time	getULPhaseDuration () const
bool	hasUplinkBurst () const
void	onFUNCreated ()
	Resolve inter-FU dependencies.
void	onTimeout ()
	Your callback. Implement this.
bool	resourcesGranted ()
	ULMapCollector (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &config)
Private Attributes
wns::simulator::Time	burstEndTime_
wns::SmartPtr< const wns::service::phy::phymode::PhyModeInterface >	burstPhyMode
wns::simulator::Time	burstStartTime_
wimac::Component *	component_
wimac::service::ConnectionManager *	connectionManager_
wns::scheduler::ChannelQualityOnOneSubChannel	estimatedCQI_
bool	hasUplinkBurst_
wns::scheduler::UserID	me_
wns::scheduler::MapInfoCollectionPtr	myBursts_
wns::SmartPtr< const wns::service::phy::phymode::PhyModeInterface >	phyMode
	PhyMode to be used for the MAP.
wimac::PhyUser *	phyUser_
wns::scheduler::SchedulingMapPtr	scheduledULMap_
wns::simulator::Time	ulPhaseDuration_
bool	ulResourcesAvailable_
	PhyMode to be used for the burst.
wimac::scheduler::Scheduler *	ulScheduler_
std::string	ulSchedulerName_