wns::scheduler::SchedulingTimeSlot Class Reference

class to describe one SchedulingTimeSlot. There is one of this object in the subChannel for each timeSlot.

#include <scheduler/SchedulingMap.hpp>

Inheritance diagram for wns::scheduler::SchedulingTimeSlot:

Collaboration diagram for wns::scheduler::SchedulingTimeSlot:

List of all members.

Public Member Functions

void consistencyCheck ()

int countScheduledCompounds () const

number of compounds inside this resource

void deleteCompounds ()

Delete all compounds. But keep all other info (PhyMode, usedTime). This is called by the UL master scheduler, because there are no "real" compounds (just fakes).

std::string dumpContents (const std::string &prefix) const

output structure (machine readable table for Matlab,Gnuplot,etc)

wns::scheduler::ChannelQualityOnOneSubChannel getEstimatedCQI (wns::scheduler::UserID user) const

simTimeType getFreeTime () const

total free time on this SchedulingTimeSlot

int getNetBlockSizeInBits () const

determine the length in bits stored in this resource

wns::scheduler::UserID getSourceUserID () const

wns::Power getTxPower () const

get txPower assigned to this resource. Assumes that all contents are for ONE user only and have all equal power.

simTimeType getUsedTime () const

total used time in this SchedulingTimeSlot

wns::scheduler::UserID getUserID () const

get userID this resource has been reserved for or NULL if empty. Assumes that all contents are for ONE user only.

void grantFullResources ()

extent the usage of each resource to 100% so that UL master map doesn't waste resources.

bool hasResourcesForUser (wns::scheduler::UserID user) const

checks if there are UL resources available for given user

bool isEmpty () const

true if there is nothing reserved(scheduled) in this block. For the uplink the master map entries have isEmpty==false. This question is NOT enough to allow it to be used. see subChannelIsUsable.

bool isHARQEnabled () const

bool pduFitsInto (strategy::RequestForResource &request, MapInfoEntryPtr mapInfoEntry) const

true if compound can be put into the ResourceBlock

void processMasterMap ()

perform modifications to use this as MasterMap (called in uplink slave scheduler)

SchedulingTimeSlot (int _subChannel, int _timeSlot, int _numSpatialLayers, simTimeType _slotLength)

SchedulingTimeSlot (const SchedulingTimeSlot &other)

SchedulingTimeSlot ()

void setTxPower (wns::Power power)

set txPower assigned to this resource. Assumes that all contents are for ONE user only. All contents get the same power. Must only be used by APC styrategies.

std::string toString () const

doToString(): human-readable format

~SchedulingTimeSlot ()

Public Attributes

HARQInfo harq

int numSpatialLayers

size of resources in spatial direction. This can be beamforming beams (available for WiMAC) or MIMO paths.

PhysicalResourceBlockVector physicalResources

collection of all PhysicalResourceBlocks (one per MIMO beam; only one for SISO)

simTimeType slotLength

fixed frame/slot length given from outside

int subChannelIndex

my own subChannelIndex as seen from outside (container)

int timeSlotIndex

number of resource blocks in time-direction

bool timeSlotIsUsable

isUsable = flag to exclude certain resources from DSA

simTimeType timeSlotStartTime

fixed frame/slot length given from outside

Detailed Description

Definition at line 328 of file SchedulingMap.hpp.

Constructor & Destructor Documentation

SchedulingTimeSlot::SchedulingTimeSlot ( )

Definition at line 590 of file SchedulingMap.cpp.

SchedulingTimeSlot::SchedulingTimeSlot ( const SchedulingTimeSlot & other )

Definition at line 620 of file SchedulingMap.cpp.

SchedulingTimeSlot::SchedulingTimeSlot	(	int	_subChannel,
		int	_timeSlot,
		int	_numSpatialLayers,
		simTimeType	_slotLength
	)

Definition at line 599 of file SchedulingMap.cpp.

SchedulingTimeSlot::~SchedulingTimeSlot ( )

Definition at line 637 of file SchedulingMap.cpp.

Member Function Documentation

void SchedulingTimeSlot::consistencyCheck ( )

Definition at line 642 of file SchedulingMap.cpp.

int SchedulingTimeSlot::countScheduledCompounds ( ) const

Definition at line 675 of file SchedulingMap.cpp.

void SchedulingTimeSlot::deleteCompounds ( )

Definition at line 790 of file SchedulingMap.cpp.

std::string SchedulingTimeSlot::dumpContents ( const std::string & prefix ) const

Definition at line 757 of file SchedulingMap.cpp.

wns::scheduler::ChannelQualityOnOneSubChannel SchedulingTimeSlot::getEstimatedCQI ( wns::scheduler::UserID user ) const

Definition at line 828 of file SchedulingMap.cpp.

simTimeType SchedulingTimeSlot::getFreeTime ( ) const

Definition at line 663 of file SchedulingMap.cpp.

int SchedulingTimeSlot::getNetBlockSizeInBits ( ) const

Definition at line 839 of file SchedulingMap.cpp.

wns::scheduler::UserID SchedulingTimeSlot::getSourceUserID ( ) const

Definition at line 721 of file SchedulingMap.cpp.

wns::Power SchedulingTimeSlot::getTxPower ( ) const

Definition at line 733 of file SchedulingMap.cpp.

simTimeType SchedulingTimeSlot::getUsedTime ( ) const

Definition at line 651 of file SchedulingMap.cpp.

wns::scheduler::UserID SchedulingTimeSlot::getUserID ( ) const

Definition at line 709 of file SchedulingMap.cpp.

void SchedulingTimeSlot::grantFullResources ( )

Definition at line 799 of file SchedulingMap.cpp.

bool SchedulingTimeSlot::hasResourcesForUser ( wns::scheduler::UserID user ) const

Definition at line 817 of file SchedulingMap.cpp.

bool SchedulingTimeSlot::isEmpty ( ) const

Definition at line 686 of file SchedulingMap.cpp.

bool SchedulingTimeSlot::isHARQEnabled ( ) const

Definition at line 850 of file SchedulingMap.cpp.

bool SchedulingTimeSlot::pduFitsInto	(	strategy::RequestForResource &	request,
		MapInfoEntryPtr	mapInfoEntry
	)			const

Definition at line 696 of file SchedulingMap.cpp.

void SchedulingTimeSlot::processMasterMap ( )

Definition at line 808 of file SchedulingMap.cpp.

void SchedulingTimeSlot::setTxPower ( wns::Power power )

Definition at line 746 of file SchedulingMap.cpp.

std::string SchedulingTimeSlot::toString ( ) const

Definition at line 775 of file SchedulingMap.cpp.

Member Data Documentation

HARQInfo wns::scheduler::SchedulingTimeSlot::harq

Definition at line 402 of file SchedulingMap.hpp.

int wns::scheduler::SchedulingTimeSlot::numSpatialLayers

Definition at line 394 of file SchedulingMap.hpp.

PhysicalResourceBlockVector wns::scheduler::SchedulingTimeSlot::physicalResources

Definition at line 386 of file SchedulingMap.hpp.

simTimeType wns::scheduler::SchedulingTimeSlot::slotLength

Definition at line 396 of file SchedulingMap.hpp.

int wns::scheduler::SchedulingTimeSlot::subChannelIndex

Definition at line 388 of file SchedulingMap.hpp.

int wns::scheduler::SchedulingTimeSlot::timeSlotIndex

Definition at line 390 of file SchedulingMap.hpp.

bool wns::scheduler::SchedulingTimeSlot::timeSlotIsUsable

Definition at line 400 of file SchedulingMap.hpp.

simTimeType wns::scheduler::SchedulingTimeSlot::timeSlotStartTime

Definition at line 398 of file SchedulingMap.hpp.

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

framework/library/src/scheduler/SchedulingMap.hpp
framework/library/src/scheduler/SchedulingMap.cpp


Public Member Functions
void	consistencyCheck ()
int	countScheduledCompounds () const
	number of compounds inside this resource
void	deleteCompounds ()
	Delete all compounds. But keep all other info (PhyMode, usedTime). This is called by the UL master scheduler, because there are no "real" compounds (just fakes).
std::string	dumpContents (const std::string &prefix) const
	output structure (machine readable table for Matlab,Gnuplot,etc)
wns::scheduler::ChannelQualityOnOneSubChannel	getEstimatedCQI (wns::scheduler::UserID user) const
simTimeType	getFreeTime () const
	total free time on this SchedulingTimeSlot
int	getNetBlockSizeInBits () const
	determine the length in bits stored in this resource
wns::scheduler::UserID	getSourceUserID () const
wns::Power	getTxPower () const
	get txPower assigned to this resource. Assumes that all contents are for ONE user only and have all equal power.
simTimeType	getUsedTime () const
	total used time in this SchedulingTimeSlot
wns::scheduler::UserID	getUserID () const
	get userID this resource has been reserved for or NULL if empty. Assumes that all contents are for ONE user only.
void	grantFullResources ()
	extent the usage of each resource to 100% so that UL master map doesn't waste resources.
bool	hasResourcesForUser (wns::scheduler::UserID user) const
	checks if there are UL resources available for given user
bool	isEmpty () const
	true if there is nothing reserved(scheduled) in this block. For the uplink the master map entries have isEmpty==false. This question is NOT enough to allow it to be used. see subChannelIsUsable.
bool	isHARQEnabled () const
bool	pduFitsInto (strategy::RequestForResource &request, MapInfoEntryPtr mapInfoEntry) const
	true if compound can be put into the ResourceBlock
void	processMasterMap ()
	perform modifications to use this as MasterMap (called in uplink slave scheduler)
	SchedulingTimeSlot (int _subChannel, int _timeSlot, int _numSpatialLayers, simTimeType _slotLength)
	SchedulingTimeSlot (const SchedulingTimeSlot &other)
	SchedulingTimeSlot ()
void	setTxPower (wns::Power power)
	set txPower assigned to this resource. Assumes that all contents are for ONE user only. All contents get the same power. Must only be used by APC styrategies.
std::string	toString () const
	doToString(): human-readable format
	~SchedulingTimeSlot ()
Public Attributes
HARQInfo	harq
int	numSpatialLayers
	size of resources in spatial direction. This can be beamforming beams (available for WiMAC) or MIMO paths.
PhysicalResourceBlockVector	physicalResources
	collection of all PhysicalResourceBlocks (one per MIMO beam; only one for SISO)
simTimeType	slotLength
	fixed frame/slot length given from outside
int	subChannelIndex
	my own subChannelIndex as seen from outside (container)
int	timeSlotIndex
	number of resource blocks in time-direction
bool	timeSlotIsUsable
	isUsable = flag to exclude certain resources from DSA
simTimeType	timeSlotStartTime
	fixed frame/slot length given from outside