User Manual, Developers Guide and API Documentation

wns::scheduler::strategy::SchedulerState Class Reference

one RevolvingStatePtr entry per timeFrame if keepStateHistory==true More...

#include <scheduler/strategy/SchedulerState.hpp>

Inheritance diagram for wns::scheduler::strategy::SchedulerState:

Inheritance graph
[legend]
Collaboration diagram for wns::scheduler::strategy::SchedulerState:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void clearMap ()
 clear MapInfoEntryCollection
virtual RevolvingStatePtr getCurrentState ()
 get (volatile) current state
virtual
wns::service::phy::phymode::PhyModeInterfacePtr 
getDefaultPhyMode ()
 SchedulerState (strategy::StrategyInterface *_strategy)
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
 ~SchedulerState ()

Public Attributes

RevolvingStatePtr currentState
 this is the part of the state which changes from timeFrame to timeFrame and from call to call of doStartScheduling
wns::service::phy::phymode::PhyModeInterfacePtr defaultPhyModePtr
 constant PhyMode if not set adaptively
wns::Power defaultTxPower
 constant txPower if not set adaptively
bool eirpLimited
 attribute from ofdmaProvider->isEIRPLimited()
bool excludeTooLowSINR
 PyConfig Attribute: flag to determine whether doAdaptiveResourceScheduling cares for too low SINR.
bool isDL
 isDL==true for RS-TX (DL) in (BS,RN-BS)
bool isTx
 isTx==true for RS-TX (DL,UL) in (BS,UT,RN)
bool keepResultHistory
 keepResultHistory=true means we can recall the StrategyResult of elapsed timeFrames
UserID myUserID
 userID of my own station/terminal myself
PowerCapabilities powerCapabilities
 adaptive power limits (Tx: OK; Rx: depend on user). Here we assume that every user has the same PowerCapabilities. Otherwise we must always ask schedulerState->strategy->getPowerCapabilities(request.user);
PowerControlType powerControlType
 there are three positions for the scheduler...
SchedulerSpotType schedulerSpot
 there are three positions for the scheduler...
strategy::StrategyInterfacestrategy
simTimeType symbolDuration
 time duration of one OFDM symbol
bool useCQI
 useCQI==true if CQI should be used for SINR estimation per subChannel. Otherwise the old method for a flat channel with grouping and estimatedCandI is used


Detailed Description

This collection of parameters is given to subStrategies and DSA/APC strategies This state is persistent within each scheduler object.

Definition at line 152 of file SchedulerState.hpp.


Constructor & Destructor Documentation

wns::scheduler::strategy::SchedulerState::SchedulerState ( strategy::StrategyInterface _strategy  )  [inline]

Definition at line 156 of file SchedulerState.hpp.

wns::scheduler::strategy::SchedulerState::~SchedulerState (  )  [inline]

Definition at line 176 of file SchedulerState.hpp.


Member Function Documentation

virtual void wns::scheduler::strategy::SchedulerState::clearMap (  )  [inline, virtual]

Definition at line 192 of file SchedulerState.hpp.

virtual RevolvingStatePtr wns::scheduler::strategy::SchedulerState::getCurrentState (  )  [inline, virtual]

Definition at line 197 of file SchedulerState.hpp.

virtual wns::service::phy::phymode::PhyModeInterfacePtr wns::scheduler::strategy::SchedulerState::getDefaultPhyMode (  )  [inline, virtual]

Definition at line 184 of file SchedulerState.hpp.

virtual void wns::scheduler::strategy::SchedulerState::setDefaultPhyMode ( wns::service::phy::phymode::PhyModeInterfacePtr  _phyModePtr  )  [inline, virtual]

Definition at line 181 of file SchedulerState.hpp.

virtual void wns::scheduler::strategy::SchedulerState::setDefaultTxPower ( wns::Power  _txPower  )  [inline, virtual]

Definition at line 189 of file SchedulerState.hpp.


Member Data Documentation

Definition at line 237 of file SchedulerState.hpp.

Definition at line 203 of file SchedulerState.hpp.

Definition at line 205 of file SchedulerState.hpp.

Definition at line 233 of file SchedulerState.hpp.

Definition at line 226 of file SchedulerState.hpp.

Definition at line 213 of file SchedulerState.hpp.

Definition at line 211 of file SchedulerState.hpp.

Definition at line 229 of file SchedulerState.hpp.

Definition at line 223 of file SchedulerState.hpp.

Definition at line 209 of file SchedulerState.hpp.

Definition at line 219 of file SchedulerState.hpp.

Definition at line 221 of file SchedulerState.hpp.

Definition at line 201 of file SchedulerState.hpp.

Definition at line 231 of file SchedulerState.hpp.

Definition at line 217 of file SchedulerState.hpp.


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

Generated on Sun May 27 03:33:04 2012 for openWNS by  doxygen 1.5.5