A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
ns3::FfMacScheduler Class Reference

#include <ff-mac-scheduler.h>

+ Inheritance diagram for ns3::FfMacScheduler:
+ Collaboration diagram for ns3::FfMacScheduler:

Public Member Functions

virtual ~FfMacScheduler ()
virtual void DoDispose (void)
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider ()=0
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider ()=0
virtual void SetFfMacCschedSapUser (FfMacCschedSapUser *s)=0
virtual void SetFfMacSchedSapUser (FfMacSchedSapUser *s)=0
- 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
SimpleRefCount & operator= (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::FfMacScheduler.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoStart (void)
virtual void NotifyNewAggregate (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.

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

Constructor & Destructor Documentation

ns3::FfMacScheduler::~FfMacScheduler ( )
virtual

destructor

Definition at line 32 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::PfFfMacScheduler, and ns3::RrFfMacScheduler.

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

References NS_LOG_FUNCTION.

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

Implemented in ns3::PfFfMacScheduler, and ns3::RrFfMacScheduler.

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

Implemented in ns3::PfFfMacScheduler, and ns3::RrFfMacScheduler.

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

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

This object 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

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::PfFfMacScheduler, and ns3::RrFfMacScheduler.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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::PfFfMacScheduler, 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::PfFfMacScheduler, and ns3::RrFfMacScheduler.

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