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:

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)
	Destructor implementation. More...

virtual FfMacCschedSapProvider *	GetFfMacCschedSapProvider ()=0

virtual FfMacSchedSapProvider *	GetFfMacSchedSapProvider ()=0

virtual LteFfrSapUser *	GetLteFfrSapUser ()=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...

virtual void	SetLteFfrSapProvider (LteFfrSapProvider *s)=0
	Set the Provider part of the LteFfrSap that this Scheduler will interact with. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default 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 operator. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

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

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

Protected Attributes
UlCqiFilter_t	m_ulCqiFilter
	UL CQI filter. More...

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

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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::LteNetDevice/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/FfMacScheduler"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/FfMacScheduler"

Attributes

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

No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

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

Member Enumeration Documentation

◆ UlCqiFilter_t

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 61 of file ff-mac-scheduler.h.

Constructor & Destructor Documentation

◆ FfMacScheduler()

ns3::FfMacScheduler::FfMacScheduler ( )

constructor

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

References NS_LOG_FUNCTION.

◆ ~FfMacScheduler()

ns3::FfMacScheduler::~FfMacScheduler ( )

virtual

destructor

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::FfMacScheduler::DoDispose ( void )

virtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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::FdTbfqFfMacScheduler, ns3::CqaFfMacScheduler, ns3::PssFfMacScheduler, ns3::TdTbfqFfMacScheduler, ns3::FdBetFfMacScheduler, ns3::TdBetFfMacScheduler, ns3::PfFfMacScheduler, ns3::FdMtFfMacScheduler, ns3::TdMtFfMacScheduler, ns3::TtaFfMacScheduler, and ns3::RrFfMacScheduler.

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

References NS_LOG_FUNCTION.

◆ GetFfMacCschedSapProvider()

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

pure virtual

Returns: the Provider part of the FfMacCschedSap provided by the Scheduler

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

◆ GetFfMacSchedSapProvider()

virtual FfMacSchedSapProvider* ns3::FfMacScheduler::GetFfMacSchedSapProvider ( )

pure virtual

Returns: the Provider part of the FfMacSchedSap provided by the Scheduler

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

◆ GetLteFfrSapUser()

virtual LteFfrSapUser* ns3::FfMacScheduler::GetLteFfrSapUser ( )

pure virtual

Returns: the User part of the LteFfrSap provided by the FfrAlgorithm

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

◆ GetTypeId()

TypeId ns3::FfMacScheduler::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References ALL_UL_CQI, m_ulCqiFilter, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), PUSCH_UL_CQI, ns3::TypeId::SetParent(), and SRS_UL_CQI.

◆ SetFfMacCschedSapUser()

virtual void ns3::FfMacScheduler::SetFfMacCschedSapUser ( FfMacCschedSapUser * s )

pure 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

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

◆ SetFfMacSchedSapUser()

virtual void ns3::FfMacScheduler::SetFfMacSchedSapUser ( FfMacSchedSapUser * s )

pure 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

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

◆ SetLteFfrSapProvider()

virtual void ns3::FfMacScheduler::SetLteFfrSapProvider ( LteFfrSapProvider * s )

pure virtual

Set the Provider part of the LteFfrSap that this Scheduler will interact with.

Parameters

s

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

Member Data Documentation

◆ m_ulCqiFilter

UlCqiFilter_t ns3::FfMacScheduler::m_ulCqiFilter

protected

UL CQI filter.

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

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

src/lte/model/ff-mac-scheduler.h
src/lte/model/ff-mac-scheduler.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Member Enumeration Documentation

◆ UlCqiFilter_t

Constructor & Destructor Documentation

◆ FfMacScheduler()

◆ ~FfMacScheduler()

Member Function Documentation

◆ DoDispose()

◆ GetFfMacCschedSapProvider()

◆ GetFfMacSchedSapProvider()

◆ GetLteFfrSapUser()

◆ GetTypeId()

◆ SetFfMacCschedSapUser()

◆ SetFfMacSchedSapUser()

◆ SetLteFfrSapProvider()

Member Data Documentation

◆ m_ulCqiFilter