ns-3
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:

List of all members.

Public Member Functions

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

Friends

class PfSchedulerMemberCschedSapProvider
class PfSchedulerMemberSchedSapProvider

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


Constructor & Destructor Documentation

ns3::PfFfMacScheduler::PfFfMacScheduler ( )

Constructor.

Creates the MAC Scheduler interface implementation

ns3::PfFfMacScheduler::~PfFfMacScheduler ( )
virtual

Destructor

References NS_LOG_FUNCTION.


Member Function Documentation

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.

References NS_LOG_FUNCTION.

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

Implements ns3::FfMacScheduler.

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

Implements ns3::FfMacScheduler.

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.

References ns3::TypeId::SetParent().

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.

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.


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