This abstract base class identifies the interface by means of which the helper object can plug on the MAC a scheduler implementation based on the FF MAC Sched API. More...

#include <ff-mac-scheduler.h>

Inheritance diagram for ns3::FfMacScheduler:

Collaboration diagram for ns3::FfMacScheduler:

Public Types
enum	UlCqiFilter_t { SRS_UL_CQI, PUSCH_UL_CQI, ALL_UL_CQI }
	The type of UL CQI to be filtered (ALL means accept all the CQI, where a new CQI of any type overwrite the old one, even of another type) More...

Public Member Functions
	FfMacScheduler ()
	constructor More...

virtual	~FfMacScheduler ()
	destructor More...

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual FfMacCschedSapProvider *	GetFfMacCschedSapProvider ()=0

virtual FfMacSchedSapProvider *	GetFfMacSchedSapProvider ()=0

virtual void	SetFfMacCschedSapUser (FfMacCschedSapUser *s)=0
	set the user part of the FfMacCschedSap that this Scheduler will interact with. More...

virtual void	SetFfMacSchedSapUser (FfMacSchedSapUser *s)=0
	set the user part of the FfMacSchedSap that this Scheduler will interact with. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Attributes
UlCqiFilter_t	m_ulCqiFilter

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

This abstract base class identifies the interface by means of which the helper object can plug on the MAC a scheduler implementation based on the FF MAC Sched API.

Config Paths

ns3::FfMacScheduler is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes

UlCqiFilter: The filter to apply on UL CQIs received
- Set with class: ns3::EnumValue
- Underlying type: SRS_UL_CQI|PUSCH_UL_CQI|ALL_UL_CQI
- Initial value: ALL_UL_CQI
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 51 of file ff-mac-scheduler.h.

Member Enumeration Documentation

enum ns3::FfMacScheduler::UlCqiFilter_t

The type of UL CQI to be filtered (ALL means accept all the CQI, where a new CQI of any type overwrite the old one, even of another type)

Enumerator
SRS_UL_CQI
PUSCH_UL_CQI
ALL_UL_CQI

Definition at line 59 of file ff-mac-scheduler.h.

Constructor & Destructor Documentation

ns3::FfMacScheduler::FfMacScheduler ( )

constructor

Definition at line 35 of file ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

ns3::FfMacScheduler::~FfMacScheduler ( )

virtual

destructor

Definition at line 42 of file ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::FfMacScheduler::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::Object.

Reimplemented in ns3::PssFfMacScheduler, ns3::FdTbfqFfMacScheduler, ns3::TdTbfqFfMacScheduler, ns3::FdBetFfMacScheduler, ns3::TdBetFfMacScheduler, ns3::PfFfMacScheduler, ns3::FdMtFfMacScheduler, ns3::TdMtFfMacScheduler, ns3::TtaFfMacScheduler, and ns3::RrFfMacScheduler.

Definition at line 48 of file ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

virtual FfMacCschedSapProvider* ns3::FfMacScheduler::GetFfMacCschedSapProvider ( )

pure virtual