A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::PfFfMacScheduler Class Reference

Implements the SCHED SAP and CSCHED SAP for a Proportional Fair scheduler. More...

#include <pf-ff-mac-scheduler.h>

+ Inheritance diagram for ns3::PfFfMacScheduler:
+ Collaboration diagram for ns3::PfFfMacScheduler:

Public Member Functions

 PfFfMacScheduler ()
 Constructor.
virtual ~PfFfMacScheduler ()
virtual void DoDispose (void)
virtual FfMacCschedSapProviderGetFfMacCschedSapProvider ()
virtual FfMacSchedSapProviderGetFfMacSchedSapProvider ()
virtual void SetFfMacCschedSapUser (FfMacCschedSapUser *s)
virtual void SetFfMacSchedSapUser (FfMacSchedSapUser *s)
void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode)
- Public Member Functions inherited from ns3::FfMacScheduler
virtual ~FfMacScheduler ()
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::PfFfMacScheduler.

Private Member Functions

void DoCschedCellConfigReq (const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
void DoCschedLcConfigReq (const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
void DoCschedLcReleaseReq (const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
void DoCschedUeConfigReq (const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
void DoCschedUeReleaseReq (const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
void DoSchedDlCqiInfoReq (const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
void DoSchedDlMacBufferReq (const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
void DoSchedDlPagingBufferReq (const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
void DoSchedDlRachInfoReq (const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
void DoSchedDlRlcBufferReq (const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
void DoSchedDlTriggerReq (const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
void DoSchedUlCqiInfoReq (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
void DoSchedUlMacCtrlInfoReq (const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
void DoSchedUlNoiseInterferenceReq (const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
void DoSchedUlSrInfoReq (const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
void DoSchedUlTriggerReq (const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
double EstimateUlSinr (uint16_t rnti, uint16_t rb)
int GetRbgSize (int dlbandwidth)
int LcActivePerFlow (uint16_t rnti)
void RefreshDlCqiMaps (void)
void RefreshUlCqiMaps (void)
void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size)
void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size)

Private Attributes

std::map< uint16_t,
SbMeasResult_s
m_a30CqiRxed
std::map< uint16_t, uint32_t > m_a30CqiTimers
std::map< uint16_t,
std::vector< uint16_t > > 
m_allocationMaps
Ptr< LteAmcm_amc
std::map< uint16_t, uint32_t > m_ceBsrRxed
uint32_t m_cqiTimersThreshold
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
FfMacCschedSapProviderm_cschedSapProvider
FfMacCschedSapUserm_cschedSapUser
std::map< uint16_t, pfsFlowPerf_tm_flowStatsDl
std::map< uint16_t, pfsFlowPerf_tm_flowStatsUl
uint16_t m_nextRntiUl
std::map< uint16_t, uint8_t > m_p10CqiRxed
std::map< uint16_t, uint32_t > m_p10CqiTimers
std::map< LteFlowId_t,
FfMacSchedSapProvider::SchedDlRlcBufferReqParameters
m_rlcBufferReq
FfMacSchedSapProviderm_schedSapProvider
FfMacSchedSapUserm_schedSapUser
double m_timeWindow
std::map< uint16_t,
std::vector< double > > 
m_ueCqi
std::map< uint16_t, uint32_t > m_ueCqiTimers
std::map< uint16_t, uint8_t > m_uesTxMode

Friends

class PfSchedulerMemberCschedSapProvider
class PfSchedulerMemberSchedSapProvider

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Detailed Description

Implements the SCHED SAP and CSCHED SAP for a Proportional Fair scheduler.

This class implements the interface defined by the FfMacScheduler abstract class

Definition at line 61 of file pf-ff-mac-scheduler.h.

Constructor & Destructor Documentation

ns3::PfFfMacScheduler::PfFfMacScheduler ( )

Constructor.

Creates the MAC Scheduler interface implementation

Definition at line 214 of file pf-ff-mac-scheduler.cc.

References m_amc, m_cschedSapProvider, m_schedSapProvider, PfSchedulerMemberCschedSapProvider, and PfSchedulerMemberSchedSapProvider.

ns3::PfFfMacScheduler::~PfFfMacScheduler ( )
virtual

Destructor

Definition at line 225 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::PfFfMacScheduler::DoCschedCellConfigReq ( const struct FfMacCschedSapProvider::CschedCellConfigReqParameters params)
private
void ns3::PfFfMacScheduler::DoCschedLcReleaseReq ( const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters params)
private

Definition at line 343 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberCschedSapProvider::CschedLcReleaseReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoCschedUeReleaseReq ( const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters params)
private

Definition at line 351 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberCschedSapProvider::CschedUeReleaseReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::FfMacScheduler.

Definition at line 231 of file pf-ff-mac-scheduler.cc.

References m_cschedSapProvider, m_schedSapProvider, and NS_LOG_FUNCTION.

void ns3::PfFfMacScheduler::DoSchedDlMacBufferReq ( const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters params)
private

Definition at line 392 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberSchedSapProvider::SchedDlMacBufferReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoSchedDlPagingBufferReq ( const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters params)
private

Definition at line 384 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberSchedSapProvider::SchedDlPagingBufferReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoSchedDlRachInfoReq ( const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters params)
private

Definition at line 714 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberSchedSapProvider::SchedDlRachInfoReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoSchedUlMacCtrlInfoReq ( const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters params)
private
void ns3::PfFfMacScheduler::DoSchedUlNoiseInterferenceReq ( const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters params)
private

Definition at line 1001 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberSchedSapProvider::SchedUlNoiseInterferenceReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoSchedUlSrInfoReq ( const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters params)
private

Definition at line 1009 of file pf-ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PfSchedulerMemberSchedSapProvider::SchedUlSrInfoReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::DoSchedUlTriggerReq ( const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters params)
private
double ns3::PfFfMacScheduler::EstimateUlSinr ( uint16_t  rnti,
uint16_t  rb 
)
private

Definition at line 783 of file pf-ff-mac-scheduler.cc.

References m_cschedCellConfig, m_ueCqi, ns3::FfMacCschedSapProvider::CschedCellConfigReqParameters::m_ulBandwidth, and NO_SINR.

Referenced by DoSchedUlTriggerReq().

+ Here is the caller graph for this function:

FfMacCschedSapProvider * ns3::PfFfMacScheduler::GetFfMacCschedSapProvider ( )
virtual
Returns
the Provider part of the FfMacCschedSap provided by the Scheduler

Implements ns3::FfMacScheduler.

Definition at line 268 of file pf-ff-mac-scheduler.cc.

References m_cschedSapProvider.

FfMacSchedSapProvider * ns3::PfFfMacScheduler::GetFfMacSchedSapProvider ( )
virtual
Returns
the Provider part of the FfMacSchedSap provided by the Scheduler

Implements ns3::FfMacScheduler.

Definition at line 274 of file pf-ff-mac-scheduler.cc.

References m_schedSapProvider.

int ns3::PfFfMacScheduler::GetRbgSize ( int  dlbandwidth)
private

Definition at line 400 of file pf-ff-mac-scheduler.cc.

References ns3::PfType0AllocationRbg.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

TypeId ns3::PfFfMacScheduler::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::PfFfMacScheduler.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/FfMacScheduler/$ns3::PfFfMacScheduler
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/FfMacScheduler/$ns3::PfFfMacScheduler

Attributes defined for this type:

  • CqiTimerThreshold: The number of TTIs a CQI is valid (default 1000 - 1 sec.)

No TraceSources defined for this type.

Reimplemented from ns3::FfMacScheduler.

Definition at line 239 of file pf-ff-mac-scheduler.cc.

References m_cqiTimersThreshold, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

int ns3::PfFfMacScheduler::LcActivePerFlow ( uint16_t  rnti)
private

Definition at line 415 of file pf-ff-mac-scheduler.cc.

References m_rlcBufferReq.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::RefreshDlCqiMaps ( void  )
private

Definition at line 1111 of file pf-ff-mac-scheduler.cc.

References m_a30CqiRxed, m_a30CqiTimers, m_p10CqiRxed, m_p10CqiTimers, NS_ASSERT_MSG, and NS_LOG_INFO.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::RefreshUlCqiMaps ( void  )
private

Definition at line 1164 of file pf-ff-mac-scheduler.cc.

References m_ueCqi, m_ueCqiTimers, NS_ASSERT_MSG, and NS_LOG_INFO.

Referenced by DoSchedUlTriggerReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::SetFfMacCschedSapUser ( FfMacCschedSapUser s)
virtual

set the user part of the FfMacCschedSap that this Scheduler will interact with. Normally this part of the SAP is exported by the MAC.

Parameters
s

Implements ns3::FfMacScheduler.

Definition at line 256 of file pf-ff-mac-scheduler.cc.

References m_cschedSapUser.

void ns3::PfFfMacScheduler::SetFfMacSchedSapUser ( FfMacSchedSapUser s)
virtual

set the user part of the FfMacSchedSap that this Scheduler will interact with. Normally this part of the SAP is exported by the MAC.

Parameters
s

Implements ns3::FfMacScheduler.

Definition at line 262 of file pf-ff-mac-scheduler.cc.

References m_schedSapUser.

void ns3::PfFfMacScheduler::TransmissionModeConfigurationUpdate ( uint16_t  rnti,
uint8_t  txMode 
)
void ns3::PfFfMacScheduler::UpdateDlRlcBufferInfo ( uint16_t  rnti,
uint8_t  lcid,
uint16_t  size 
)
private

Definition at line 1194 of file pf-ff-mac-scheduler.cc.

References m_rlcBufferReq, and NS_LOG_ERROR.

Referenced by DoSchedDlTriggerReq().

+ Here is the caller graph for this function:

void ns3::PfFfMacScheduler::UpdateUlRlcBufferInfo ( uint16_t  rnti,
uint16_t  size 
)
private

Definition at line 1245 of file pf-ff-mac-scheduler.cc.

References m_ceBsrRxed, and NS_LOG_ERROR.

Referenced by DoSchedUlTriggerReq().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

Definition at line 86 of file pf-ff-mac-scheduler.h.

Referenced by PfFfMacScheduler().

friend class PfSchedulerMemberSchedSapProvider
friend

Definition at line 87 of file pf-ff-mac-scheduler.h.

Referenced by PfFfMacScheduler().

Member Data Documentation

std::map<uint16_t,SbMeasResult_s> ns3::PfFfMacScheduler::m_a30CqiRxed
private
std::map<uint16_t,uint32_t> ns3::PfFfMacScheduler::m_a30CqiTimers
private

Definition at line 181 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), and RefreshDlCqiMaps().

std::map<uint16_t, std::vector <uint16_t> > ns3::PfFfMacScheduler::m_allocationMaps
private

Definition at line 187 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedUlCqiInfoReq(), and DoSchedUlTriggerReq().

Ptr<LteAmc> ns3::PfFfMacScheduler::m_amc
private
std::map<uint16_t,uint32_t> ns3::PfFfMacScheduler::m_ceBsrRxed
private
uint32_t ns3::PfFfMacScheduler::m_cqiTimersThreshold
private

Definition at line 218 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), DoSchedUlCqiInfoReq(), and GetTypeId().

FfMacCschedSapProvider* ns3::PfFfMacScheduler::m_cschedSapProvider
private

Definition at line 206 of file pf-ff-mac-scheduler.h.

Referenced by DoDispose(), GetFfMacCschedSapProvider(), and PfFfMacScheduler().

FfMacCschedSapUser* ns3::PfFfMacScheduler::m_cschedSapUser
private
std::map<uint16_t, pfsFlowPerf_t> ns3::PfFfMacScheduler::m_flowStatsDl
private

Definition at line 157 of file pf-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and DoSchedDlTriggerReq().

std::map<uint16_t, pfsFlowPerf_t> ns3::PfFfMacScheduler::m_flowStatsUl
private

Definition at line 162 of file pf-ff-mac-scheduler.h.

Referenced by DoCschedLcConfigReq(), and DoSchedUlTriggerReq().

uint16_t ns3::PfFfMacScheduler::m_nextRntiUl
private

Definition at line 216 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedUlTriggerReq().

std::map<uint16_t,uint8_t> ns3::PfFfMacScheduler::m_p10CqiRxed
private

Definition at line 168 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), and RefreshDlCqiMaps().

std::map<uint16_t,uint32_t> ns3::PfFfMacScheduler::m_p10CqiTimers
private

Definition at line 172 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedDlCqiInfoReq(), and RefreshDlCqiMaps().

std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> ns3::PfFfMacScheduler::m_rlcBufferReq
private
FfMacSchedSapProvider* ns3::PfFfMacScheduler::m_schedSapProvider
private

Definition at line 207 of file pf-ff-mac-scheduler.h.

Referenced by DoDispose(), GetFfMacSchedSapProvider(), and PfFfMacScheduler().

FfMacSchedSapUser* ns3::PfFfMacScheduler::m_schedSapUser
private
double ns3::PfFfMacScheduler::m_timeWindow
private

Definition at line 214 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedDlTriggerReq(), and DoSchedUlTriggerReq().

std::map<uint16_t, std::vector <double> > ns3::PfFfMacScheduler::m_ueCqi
private
std::map<uint16_t, uint32_t> ns3::PfFfMacScheduler::m_ueCqiTimers
private

Definition at line 196 of file pf-ff-mac-scheduler.h.

Referenced by DoSchedUlCqiInfoReq(), and RefreshUlCqiMaps().

std::map<uint16_t,uint8_t> ns3::PfFfMacScheduler::m_uesTxMode
private

Definition at line 220 of file pf-ff-mac-scheduler.h.

Referenced by DoCschedUeConfigReq(), and DoSchedDlTriggerReq().


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