wns::scheduler::SchedulingSubChannel Class Reference

class to describe one SchedulingSubChannel. There is one of this object in the SchedulingMap for each subChannel. SISO/MIMO see the same. Only that for MIMO it contains 1..M PhysicalResourceBlocks

#include <scheduler/SchedulingMap.hpp>

Inheritance diagram for wns::scheduler::SchedulingSubChannel:

[legend]

Collaboration diagram for wns::scheduler::SchedulingSubChannel:

[legend]

List of all members.

Public Member Functions
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
int	getFreeBitsOnSubChannel (MapInfoEntryPtr mapInfoEntry) const
	returns number of bits that fit into the SchedulingSubChannel. Depends on PhyMode provided by mapInfoEntry.
simTimeType	getFreeTime () const
	total free time on this subchannel
simTimeType	getUsedTime () const
	total used time in this subchannel
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	pduFitsInto (strategy::RequestForResource &request, MapInfoEntryPtr mapInfoEntry) const
	get "offset for new compounds" == used time for already scheduled compounds. Zero for empty subChannel
void	processMasterMap ()
	perform modifications to use this as MasterMap (calles in uplink slave scheduler)
	SchedulingSubChannel (int _subChannelIndex, int _numberOfTimeSlots, int _numSpatialLayers, simTimeType _slotLength)
	SchedulingSubChannel ()
std::string	toString () const
	doToString(): human-readable format
	~SchedulingSubChannel ()
Public Attributes
int	numberOfTimeSlots
	number of resource blocks in time-direction
int	numSpatialLayers
	size of resources in spatial direction. This can be beamforming beams (available for WiMAC) or MIMO paths.
simTimeType	slotLength
	fixed frame/slot length given from outside
int	subChannelIndex
	my own subChannelIndex as seen from outside (container)
bool	subChannelIsUsable
	isUsable = flag to exclude certain subchannels from DSA
SchedulingTimeSlotPtrVector	temporalResources
	collection of all PhysicalResourceBlocks (one per MIMO beam; only one for SISO)

---

Detailed Description

Definition at line 418 of file SchedulingMap.hpp.

---

Constructor & Destructor Documentation

SchedulingSubChannel::SchedulingSubChannel

(

)

Definition at line 864 of file SchedulingMap.cpp.

SchedulingSubChannel::SchedulingSubChannel	(	int	_subChannelIndex,
		int	_numberOfTimeSlots,
		int	_numSpatialLayers,
		simTimeType	_slotLength
	)

Definition at line 872 of file SchedulingMap.cpp.

SchedulingSubChannel::~SchedulingSubChannel

(

)

Definition at line 887 of file SchedulingMap.cpp.

---

Member Function Documentation

void SchedulingSubChannel::deleteCompounds

(

)

Definition at line 989 of file SchedulingMap.cpp.

std::string SchedulingSubChannel::dumpContents

(

const std::string &

prefix

)

const

Definition at line 894 of file SchedulingMap.cpp.

wns::scheduler::ChannelQualityOnOneSubChannel SchedulingSubChannel::getEstimatedCQI

(

wns::scheduler::UserID

user

)

const

Definition at line 1026 of file SchedulingMap.cpp.

int SchedulingSubChannel::getFreeBitsOnSubChannel

(

MapInfoEntryPtr

mapInfoEntry

)

const

Definition at line 966 of file SchedulingMap.cpp.

simTimeType SchedulingSubChannel::getFreeTime

(

)

const

Definition at line 939 of file SchedulingMap.cpp.

simTimeType SchedulingSubChannel::getUsedTime

(

)

const

Definition at line 927 of file SchedulingMap.cpp.

void SchedulingSubChannel::grantFullResources

(

)

Definition at line 998 of file SchedulingMap.cpp.

bool SchedulingSubChannel::hasResourcesForUser

(

wns::scheduler::UserID

user

)

const

Definition at line 1015 of file SchedulingMap.cpp.

bool SchedulingSubChannel::isEmpty

(

)

const

Definition at line 979 of file SchedulingMap.cpp.

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

true if compound can be put into the SchedulingSubChannel

Definition at line 951 of file SchedulingMap.cpp.

void SchedulingSubChannel::processMasterMap

(

)

Definition at line 1007 of file SchedulingMap.cpp.

std::string SchedulingSubChannel::toString

(

)

const

Definition at line 912 of file SchedulingMap.cpp.

---

Member Data Documentation

int wns::scheduler::SchedulingSubChannel::numberOfTimeSlots

Definition at line 472 of file SchedulingMap.hpp.

int wns::scheduler::SchedulingSubChannel::numSpatialLayers

Definition at line 476 of file SchedulingMap.hpp.

simTimeType wns::scheduler::SchedulingSubChannel::slotLength

Definition at line 478 of file SchedulingMap.hpp.

int wns::scheduler::SchedulingSubChannel::subChannelIndex

Definition at line 470 of file SchedulingMap.hpp.

bool wns::scheduler::SchedulingSubChannel::subChannelIsUsable

Definition at line 480 of file SchedulingMap.hpp.

SchedulingTimeSlotPtrVector wns::scheduler::SchedulingSubChannel::temporalResources

collection of and all temporal resources = TDMA slots. SmartPtr inside.

Definition at line 484 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