A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::UplinkScheduler Class Referenceabstract
WiMAX Models

Virtual class for uplink scheduler. More...

#include <bs-uplink-scheduler.h>

+ Inheritance diagram for ns3::UplinkScheduler:

Public Member Functions

 UplinkScheduler (Ptr< BaseStationNetDevice > bs)
 
virtual void AddUplinkAllocation (OfdmUlMapIe &ulMapIe, const uint32_t &allocationSize, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)=0
 
virtual void AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols)=0
 
virtual uint32_t CalculateAllocationStartTime (void)=0
 
virtual Ptr< BaseStationNetDevice > GetBs (void)
 
virtual void GetChannelDescriptorsToUpdate (bool &, bool &, bool &, bool &)=0
 
virtual Time GetDcdTimeStamp (void) const
 
virtual bool GetIsInvIrIntrvlAllocated (void) const
 
virtual bool GetIsIrIntrvlAllocated (void) const
 
virtual uint8_t GetNrIrOppsAllocated (void) const
 
virtual Time GetTimeStampIrInterval (void)
 
virtual Time GetUcdTimeStamp (void) const
 
virtual std::list< OfdmUlMapIe > GetUplinkAllocations (void) const
 
virtual void InitOnce (void)=0
 
virtual void OnSetRequestedBandwidth (ServiceFlowRecord *sfr)=0
 
virtual void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)=0
 
virtual void Schedule (void)=0
 
virtual void ServiceBandwidthRequests (const SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)=0
 
virtual bool ServiceBandwidthRequests (ServiceFlow *serviceFlow, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)=0
 
virtual void ServiceUnsolicitedGrants (const SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)=0
 
virtual void SetBs (Ptr< BaseStationNetDevice > bs)
 
virtual void SetDcdTimeStamp (Time dcdTimeStamp)
 
virtual void SetIsInvIrIntrvlAllocated (bool isInvIrIntrvlAllocated)
 
virtual void SetIsIrIntrvlAllocated (bool isIrIntrvlAllocated)
 
virtual void SetNrIrOppsAllocated (uint8_t nrIrOppsAllocated)
 
virtual void SetTimeStampIrInterval (Time timeStampIrInterval)
 
virtual void SetUcdTimeStamp (Time ucdTimeStamp)
 
virtual void SetupServiceFlow (SSRecord *ssRecord, ServiceFlow *serviceFlow)=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
 
SimpleRefCount & operator= (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)
 

Private Attributes

Ptr< BaseStationNetDevice > m_bs
 
Time m_dcdTimeStamp
 
bool m_isInvIrIntrvlAllocated
 
bool m_isIrIntrvlAllocated
 
uint8_t m_nrIrOppsAllocated
 
Time m_timeStampIrInterval
 
Time m_ucdTimeStamp
 
std::list< OfdmUlMapIe > m_uplinkAllocations
 

Additional Inherited Members

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

Virtual class for uplink scheduler.

Config Paths

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

  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/UplinkScheduler
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/UplinkScheduler

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

Definition at line 42 of file bs-uplink-scheduler.h.

Member Function Documentation

virtual void ns3::UplinkScheduler::GetChannelDescriptorsToUpdate ( bool &  ,
bool &  ,
bool &  ,
bool &   
)
pure virtual

Determines if channel descriptors sent in the current frame are required to be updated

Implemented in ns3::UplinkSchedulerMBQoS, ns3::UplinkSchedulerRtps, and ns3::UplinkSchedulerSimple.

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