wns::scheduler::strategy::StrategyInput Class Reference

container for the basic datastructures that the scheduler strategy needs to work on. You can even derive from it and add more elements if you need them.

#include <scheduler/strategy/StrategyInterface.hpp>

Collaboration diagram for wns::scheduler::strategy::StrategyInput:

[legend]

List of all members.

Public Member Functions

virtual bool frameNrIsValid () const

virtual
wns::scheduler::SchedulingMapPtr getEmptySchedulingMap () const

get empty SchedulingMap configured with the correct resource dimensions.

virtual int getFChannels () const

virtual int getFrameNr () const

virtual
wns::scheduler::SchedulingMapPtr getInputSchedulingMap () const

get parameter inputSchedulingMap.

virtual int getMaxSpatialLayers () const

virtual int getNumberOfTimeSlots () const

virtual double getSlotLength () const

virtual void setDefaultPhyMode (wns::service::phy::phymode::PhyModeInterfacePtr _phyModePtr)

set (optional!) parameter defaultPhyMode If this is set, no other PhyMode will be used. No AMC for the simple (old) strategies

virtual void setDefaultTxPower (wns::Power _txPower)

set (optional!) parameter defaultTxPower If this is set, no other TxPower will be used. No APC for the simple (old) strategies

virtual void setFrameNr (int _frameNr)

set (optional!) parameter frameNr

virtual void setInputSchedulingMap (wns::scheduler::SchedulingMapPtr _inputSchedulingMap)

set (optional!) parameter inputSchedulingMap If this is set, the scheduler operates on previously allocated resources

StrategyInput ()

StrategyInput (int _fChannels, double _slotLength, int _numberOfTimeSlots, int _maxSpatialLayers, MapInfoEntryPtr _mapInfoEntryFromMaster, CallBackInterface *_callBackObject)

generic constructor for both types of scheduling

StrategyInput (MapInfoEntryPtr _mapInfoEntryFromMaster, CallBackInterface *_callBackObject)

constructor for slave scheduling

StrategyInput (int _fChannels, double _slotLength, int _numberOfTimeSlots, int _maxSpatialLayers, CallBackInterface *_callBackObject)

constructor for master scheduling

virtual std::string toString () const

~StrategyInput ()

Public Attributes

bool beamforming

true: use beamforming if(maxSpatialLayers>1). false: use MIMO if(maxSpatialLayers>1)

CallBackInterface * callBackObject

pointer to caller which has callBack() implemented. A value of NULL means: don't use.

wns::service::phy::phymode::PhyModeInterfacePtr defaultPhyModePtr

constant PhyMode if not set adaptively

wns::Power defaultTxPower

constant txPower if not set adaptively

int fChannels

size of resources in frequency-direction

int frameNr

frameNr is used for advance scheduling

wns::scheduler::SchedulingMapPtr inputSchedulingMap

Any scheduler can get a preassigned schedulingMap. E.g. for master-slave scheduling or for using subChannelIsUsable pre-allocations or to do multiple scheduling rounds over the same frame or to encorporate static allocations Is a SmartPtr.

MapInfoEntryPtr mapInfoEntryFromMaster

A slave scheduler gets this masterBurst from the masterScheduler via maps (DL signaling). Old method. The new method uses an inputSchedulingMap. Is a SmartPtr.

int maxSpatialLayers

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

int numberOfAntennas

Number of antenna elements at this transceiver (Tx+Rx).

int numberOfTimeSlots

number of resource blocks in time-direction

double slotLength

size of resources in time-direction

Detailed Description

Definition at line 65 of file StrategyInterface.hpp.

Constructor & Destructor Documentation

StrategyInput::StrategyInput	(	int	_fChannels,
		double	_slotLength,
		int	_numberOfTimeSlots,
		int	_maxSpatialLayers,
		CallBackInterface *	_callBackObject
	)

Definition at line 35 of file StrategyInterface.cpp.

StrategyInput::StrategyInput	(	MapInfoEntryPtr	_mapInfoEntryFromMaster,
		CallBackInterface *	_callBackObject
	)

Definition at line 55 of file StrategyInterface.cpp.

StrategyInput::StrategyInput	(	int	_fChannels,
		double	_slotLength,
		int	_numberOfTimeSlots,
		int	_maxSpatialLayers,
		MapInfoEntryPtr	_mapInfoEntryFromMaster,
		CallBackInterface *	_callBackObject
	)

Definition at line 73 of file StrategyInterface.cpp.

wns::scheduler::strategy::StrategyInput::StrategyInput ( )

StrategyInput::~StrategyInput ( )

Definition at line 90 of file StrategyInterface.cpp.

Member Function Documentation

bool StrategyInput::frameNrIsValid ( ) const [virtual]

Definition at line 103 of file StrategyInterface.cpp.

wns::scheduler::SchedulingMapPtr StrategyInput::getEmptySchedulingMap ( ) const [virtual]

Definition at line 135 of file StrategyInterface.cpp.

virtual int wns::scheduler::strategy::StrategyInput::getFChannels ( ) const [inline, virtual]

Definition at line 99 of file StrategyInterface.hpp.

virtual int wns::scheduler::strategy::StrategyInput::getFrameNr ( ) const [inline, virtual]

Definition at line 96 of file StrategyInterface.hpp.

wns::scheduler::SchedulingMapPtr StrategyInput::getInputSchedulingMap ( ) const [virtual]

Definition at line 144 of file StrategyInterface.cpp.

virtual int wns::scheduler::strategy::StrategyInput::getMaxSpatialLayers ( ) const [inline, virtual]

Definition at line 108 of file StrategyInterface.hpp.

virtual int wns::scheduler::strategy::StrategyInput::getNumberOfTimeSlots ( ) const [inline, virtual]

Definition at line 105 of file StrategyInterface.hpp.

virtual double wns::scheduler::strategy::StrategyInput::getSlotLength ( ) const [inline, virtual]

Definition at line 102 of file StrategyInterface.hpp.

void StrategyInput::setDefaultPhyMode ( wns::service::phy::phymode::PhyModeInterfacePtr _phyModePtr ) [virtual]

Definition at line 109 of file StrategyInterface.cpp.

void StrategyInput::setDefaultTxPower ( wns::Power _txPower ) [virtual]

Definition at line 115 of file StrategyInterface.cpp.

void StrategyInput::setFrameNr ( int _frameNr ) [virtual]

Definition at line 96 of file StrategyInterface.cpp.

void StrategyInput::setInputSchedulingMap ( wns::scheduler::SchedulingMapPtr _inputSchedulingMap ) [virtual]

Definition at line 150 of file StrategyInterface.cpp.

std::string StrategyInput::toString ( ) const [virtual]

Definition at line 121 of file StrategyInterface.cpp.

Member Data Documentation

bool wns::scheduler::strategy::StrategyInput::beamforming

Definition at line 154 of file StrategyInterface.hpp.

CallBackInterface* wns::scheduler::strategy::StrategyInput::callBackObject

Definition at line 163 of file StrategyInterface.hpp.

wns::service::phy::phymode::PhyModeInterfacePtr wns::scheduler::strategy::StrategyInput::defaultPhyModePtr

Definition at line 180 of file StrategyInterface.hpp.

wns::Power wns::scheduler::strategy::StrategyInput::defaultTxPower

Definition at line 183 of file StrategyInterface.hpp.

int wns::scheduler::strategy::StrategyInput::fChannels

Definition at line 141 of file StrategyInterface.hpp.

int wns::scheduler::strategy::StrategyInput::frameNr

Definition at line 186 of file StrategyInterface.hpp.

wns::scheduler::SchedulingMapPtr wns::scheduler::strategy::StrategyInput::inputSchedulingMap

Definition at line 177 of file StrategyInterface.hpp.

MapInfoEntryPtr wns::scheduler::strategy::StrategyInput::mapInfoEntryFromMaster

Definition at line 169 of file StrategyInterface.hpp.

int wns::scheduler::strategy::StrategyInput::maxSpatialLayers

Definition at line 159 of file StrategyInterface.hpp.

int wns::scheduler::strategy::StrategyInput::numberOfAntennas

Definition at line 150 of file StrategyInterface.hpp.

int wns::scheduler::strategy::StrategyInput::numberOfTimeSlots

Definition at line 147 of file StrategyInterface.hpp.

double wns::scheduler::strategy::StrategyInput::slotLength

Definition at line 144 of file StrategyInterface.hpp.

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

framework/library/src/scheduler/strategy/StrategyInterface.hpp
framework/library/src/scheduler/strategy/StrategyInterface.cpp


Public Member Functions
virtual bool	frameNrIsValid () const
virtual wns::scheduler::SchedulingMapPtr	getEmptySchedulingMap () const
	get empty SchedulingMap configured with the correct resource dimensions.
virtual int	getFChannels () const
virtual int	getFrameNr () const
virtual wns::scheduler::SchedulingMapPtr	getInputSchedulingMap () const
	get parameter inputSchedulingMap.
virtual int	getMaxSpatialLayers () const
virtual int	getNumberOfTimeSlots () const
virtual double	getSlotLength () const
virtual void	setDefaultPhyMode (wns::service::phy::phymode::PhyModeInterfacePtr _phyModePtr)
	set (optional!) parameter defaultPhyMode If this is set, no other PhyMode will be used. No AMC for the simple (old) strategies
virtual void	setDefaultTxPower (wns::Power _txPower)
	set (optional!) parameter defaultTxPower If this is set, no other TxPower will be used. No APC for the simple (old) strategies
virtual void	setFrameNr (int _frameNr)
	set (optional!) parameter frameNr
virtual void	setInputSchedulingMap (wns::scheduler::SchedulingMapPtr _inputSchedulingMap)
	set (optional!) parameter inputSchedulingMap If this is set, the scheduler operates on previously allocated resources
	StrategyInput ()
	StrategyInput (int _fChannels, double _slotLength, int _numberOfTimeSlots, int _maxSpatialLayers, MapInfoEntryPtr _mapInfoEntryFromMaster, CallBackInterface *_callBackObject)
	generic constructor for both types of scheduling
	StrategyInput (MapInfoEntryPtr _mapInfoEntryFromMaster, CallBackInterface *_callBackObject)
	constructor for slave scheduling
	StrategyInput (int _fChannels, double _slotLength, int _numberOfTimeSlots, int _maxSpatialLayers, CallBackInterface *_callBackObject)
	constructor for master scheduling
virtual std::string	toString () const
	~StrategyInput ()
Public Attributes
bool	beamforming
	true: use beamforming if(maxSpatialLayers>1). false: use MIMO if(maxSpatialLayers>1)
CallBackInterface *	callBackObject
	pointer to caller which has callBack() implemented. A value of NULL means: don't use.
wns::service::phy::phymode::PhyModeInterfacePtr	defaultPhyModePtr
	constant PhyMode if not set adaptively
wns::Power	defaultTxPower
	constant txPower if not set adaptively
int	fChannels
	size of resources in frequency-direction
int	frameNr
	frameNr is used for advance scheduling
wns::scheduler::SchedulingMapPtr	inputSchedulingMap
	Any scheduler can get a preassigned schedulingMap. E.g. for master-slave scheduling or for using subChannelIsUsable pre-allocations or to do multiple scheduling rounds over the same frame or to encorporate static allocations Is a SmartPtr.
MapInfoEntryPtr	mapInfoEntryFromMaster
	A slave scheduler gets this masterBurst from the masterScheduler via maps (DL signaling). Old method. The new method uses an inputSchedulingMap. Is a SmartPtr.
int	maxSpatialLayers
	size of resources in spatial direction. This can be beamforming spatialLayers (available for WiMAC) or MIMO paths (not yet available).
int	numberOfAntennas
	Number of antenna elements at this transceiver (Tx+Rx).
int	numberOfTimeSlots
	number of resource blocks in time-direction
double	slotLength
	size of resources in time-direction