A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::FfMacScheduler Class Referenceabstract

#include <ff-mac-scheduler.h>

+ Inheritance diagram for ns3::FfMacScheduler:

Public Types

enum  UlCqiFilter_t { SRS_UL_CQI, PUSCH_UL_CQI, ALL_UL_CQI }
 

Public Member Functions

 FfMacScheduler ()
 
virtual ~FfMacScheduler ()
 
virtual void DoDispose (void)
 
virtual FfMacCschedSapProviderGetFfMacCschedSapProvider ()=0
 
virtual FfMacSchedSapProviderGetFfMacSchedSapProvider ()=0
 
virtual void SetFfMacCschedSapUser (FfMacCschedSapUser *s)=0
 
virtual void SetFfMacSchedSapUser (FfMacSchedSapUser *s)=0
 
- Public Member Functions inherited from ns3::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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Attributes

UlCqiFilter_t m_ulCqiFilter
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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

Member Enumeration Documentation

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)

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

Constructor & Destructor Documentation

ns3::FfMacScheduler::FfMacScheduler ( )

constructor

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

References NS_LOG_FUNCTION.

ns3::FfMacScheduler::~FfMacScheduler ( )
virtual

destructor

Definition at line 41 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 47 of file ff-mac-scheduler.cc.

References NS_LOG_FUNCTION.

virtual FfMacCschedSapProvider* ns3::FfMacScheduler::GetFfMacCschedSapProvider ( )
pure virtual
virtual FfMacSchedSapProvider* ns3::FfMacScheduler::GetFfMacSchedSapProvider ( )
pure virtual
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::PssFfMacScheduler, ns3::FdTbfqFfMacScheduler, ns3::TdTbfqFfMacScheduler, ns3::FdBetFfMacScheduler, ns3::TdBetFfMacScheduler, ns3::PfFfMacScheduler, ns3::FdMtFfMacScheduler, ns3::TdMtFfMacScheduler, ns3::TtaFfMacScheduler, and ns3::RrFfMacScheduler.

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::PssFfMacScheduler, ns3::FdTbfqFfMacScheduler, ns3::TdTbfqFfMacScheduler, ns3::FdBetFfMacScheduler, ns3::TdBetFfMacScheduler, ns3::PfFfMacScheduler, ns3::FdMtFfMacScheduler, ns3::TdMtFfMacScheduler, ns3::TtaFfMacScheduler, and ns3::RrFfMacScheduler.


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