A Discrete-Event Network Simulator
API
ns3::UplinkSchedulerSimple Class Reference

Uplink Scheduler - simplified. More...

#include "bs-uplink-scheduler-simple.h"

+ Inheritance diagram for ns3::UplinkSchedulerSimple:
+ Collaboration diagram for ns3::UplinkSchedulerSimple:

Public Member Functions

 UplinkSchedulerSimple (Ptr< BaseStationNetDevice > bs)
 Constructor. More...
 
 UplinkSchedulerSimple (void)
 
 ~UplinkSchedulerSimple (void)
 
void AddUplinkAllocation (OfdmUlMapIe &ulMapIe, const uint32_t &allocationSize, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Add uplink allocation. More...
 
void AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Allocate Initial Ranging Interval function. More...
 
uint32_t CalculateAllocationStartTime (void)
 
void GetChannelDescriptorsToUpdate (bool &updateDcd, bool &updateUcd, bool &sendDcd, bool &sendUcd)
 Determines if channel descriptors sent in the current frame are required to be updated. More...
 
std::list< OfdmUlMapIeGetUplinkAllocations (void) const
 
void InitOnce (void)
 Init once function. More...
 
void OnSetRequestedBandwidth (ServiceFlowRecord *sfr)
 Set requested bandwidth function. More...
 
void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr)
 Process bandwidth requet function. More...
 
void Schedule (void)
 Schedule function. More...
 
void ServiceBandwidthRequests (const SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Service Bandwidth Requests function. More...
 
bool ServiceBandwidthRequests (ServiceFlow *serviceFlow, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Service bandwidth requests function. More...
 
void ServiceUnsolicitedGrants (const SSRecord *ssRecord, enum ServiceFlow::SchedulingType schedulingType, OfdmUlMapIe &ulMapIe, const WimaxPhy::ModulationType modulationType, uint32_t &symbolsToAllocation, uint32_t &availableSymbols)
 Service Unsolicited Grants function. More...
 
void SetupServiceFlow (SSRecord *ssRecord, ServiceFlow *serviceFlow)
 Setup service flow function. 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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...
 

Private Attributes

std::list< OfdmUlMapIem_uplinkAllocations
 uplink allocations More...
 

Additional Inherited Members

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

Detailed Description

Uplink Scheduler - simplified.

Config Paths

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

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

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

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

Constructor & Destructor Documentation

◆ UplinkSchedulerSimple() [1/2]

◆ UplinkSchedulerSimple() [2/2]

◆ ~UplinkSchedulerSimple()

ns3::UplinkSchedulerSimple::~UplinkSchedulerSimple ( void  )

Definition at line 63 of file bs-uplink-scheduler-simple.cc.

References m_uplinkAllocations, and ns3::UplinkScheduler::SetBs().

+ Here is the call graph for this function:

Member Function Documentation

◆ AddUplinkAllocation()

void ns3::UplinkSchedulerSimple::AddUplinkAllocation ( OfdmUlMapIe ulMapIe,
const uint32_t allocationSize,
uint32_t symbolsToAllocation,
uint32_t availableSymbols 
)
virtual

Add uplink allocation.

Parameters
ulMapIethe UL map IE
allocationSizethe allocation size
symbolsToAllocationthe symbols to allocation
availableSymbolsthe available symbols

Implements ns3::UplinkScheduler.

Definition at line 158 of file bs-uplink-scheduler-simple.cc.

References m_uplinkAllocations, ns3::OfdmUlMapIe::SetDuration(), and ns3::OfdmUlMapIe::SetStartTime().

Referenced by AllocateInitialRangingInterval(), Schedule(), ServiceBandwidthRequests(), and ServiceUnsolicitedGrants().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ AllocateInitialRangingInterval()

void ns3::UplinkSchedulerSimple::AllocateInitialRangingInterval ( uint32_t symbolsToAllocation,
uint32_t availableSymbols 
)
virtual

◆ CalculateAllocationStartTime()

uint32_t ns3::UplinkSchedulerSimple::CalculateAllocationStartTime ( void  )
virtual
Returns
the calculated allocation start time

Implements ns3::UplinkScheduler.

Definition at line 152 of file bs-uplink-scheduler-simple.cc.

References ns3::UplinkScheduler::GetBs().

Referenced by AllocateInitialRangingInterval().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetChannelDescriptorsToUpdate()

void ns3::UplinkSchedulerSimple::GetChannelDescriptorsToUpdate ( bool &  updateDcd,
bool &  updateUcd,
bool &  sendDcd,
bool &  sendUcd 
)
virtual

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

Parameters
updateDcdcurrently unused (assume true)
updateUcdcurrently unused (assume true)
[out]sendDcdDCD must be updated
[out]sendUcdUCD must be updated

Implements ns3::UplinkScheduler.

Definition at line 93 of file bs-uplink-scheduler-simple.cc.

References ns3::UplinkScheduler::GetBs(), ns3::UplinkScheduler::GetDcdTimeStamp(), ns3::UplinkScheduler::GetUcdTimeStamp(), ns3::Simulator::Now(), ns3::UplinkScheduler::SetDcdTimeStamp(), and ns3::UplinkScheduler::SetUcdTimeStamp().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 76 of file bs-uplink-scheduler-simple.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUplinkAllocations()

std::list< OfdmUlMapIe > ns3::UplinkSchedulerSimple::GetUplinkAllocations ( void  ) const
virtual
Returns
uplink allocations

Reimplemented from ns3::UplinkScheduler.

Definition at line 87 of file bs-uplink-scheduler-simple.cc.

References m_uplinkAllocations.

◆ InitOnce()

void ns3::UplinkSchedulerSimple::InitOnce ( void  )
virtual

Init once function.

Implements ns3::UplinkScheduler.

Definition at line 70 of file bs-uplink-scheduler-simple.cc.

◆ OnSetRequestedBandwidth()

void ns3::UplinkSchedulerSimple::OnSetRequestedBandwidth ( ServiceFlowRecord sfr)
virtual

Set requested bandwidth function.

Parameters
sfrthe service flow record

Implements ns3::UplinkScheduler.

Definition at line 582 of file bs-uplink-scheduler-simple.cc.

References ns3::ServiceFlowRecord::SetGrantedBandwidth().

+ Here is the call graph for this function:

◆ ProcessBandwidthRequest()

void ns3::UplinkSchedulerSimple::ProcessBandwidthRequest ( const BandwidthRequestHeader bwRequestHdr)
virtual

Process bandwidth requet function.

Parameters
bwRequestHdrthe bandwidth request header

Implements ns3::UplinkScheduler.

Definition at line 575 of file bs-uplink-scheduler-simple.cc.

◆ Schedule()

◆ ServiceBandwidthRequests() [1/2]

void ns3::UplinkSchedulerSimple::ServiceBandwidthRequests ( const SSRecord ssRecord,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t symbolsToAllocation,
uint32_t availableSymbols 
)
virtual

Service Bandwidth Requests function.

Parameters
ssRecordSubscriber station record
schedulingTypethe scheduling type
ulMapIethe UL map IE
modulationTypethe modulation type
symbolsToAllocationthe symbols to allocation
availableSymbolsthe available symbols

Implements ns3::UplinkScheduler.

Definition at line 406 of file bs-uplink-scheduler-simple.cc.

References ns3::SSRecord::GetServiceFlows(), and ServiceBandwidthRequests().

Referenced by Schedule(), ServiceBandwidthRequests(), and ServiceUnsolicitedGrants().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ServiceBandwidthRequests() [2/2]

bool ns3::UplinkSchedulerSimple::ServiceBandwidthRequests ( ServiceFlow serviceFlow,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t symbolsToAllocation,
uint32_t availableSymbols 
)
virtual

Service bandwidth requests function.

Parameters
serviceFlowthe service flow
schedulingTypethe scheduling type
ulMapIethe UL map IE
modulationTypethe modulation type
symbolsToAllocationthe symbols to allocation
availableSymbolsthe available symbols
Returns
true if successful

Implements ns3::UplinkScheduler.

Definition at line 430 of file bs-uplink-scheduler-simple.cc.

References AddUplinkAllocation(), ns3::UplinkScheduler::GetBs(), ns3::ServiceFlowRecord::GetGrantedBandwidth(), ns3::ServiceFlow::GetRecord(), ns3::ServiceFlowRecord::GetRequestedBandwidth(), ns3::ServiceFlow::GetSduSize(), ns3::ServiceFlowRecord::SetBwSinceLastExpiry(), ns3::ServiceFlow::SF_TYPE_NRTPS, and ns3::ServiceFlowRecord::UpdateGrantedBandwidth().

+ Here is the call graph for this function:

◆ ServiceUnsolicitedGrants()

void ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants ( const SSRecord ssRecord,
enum ServiceFlow::SchedulingType  schedulingType,
OfdmUlMapIe ulMapIe,
const WimaxPhy::ModulationType  modulationType,
uint32_t symbolsToAllocation,
uint32_t availableSymbols 
)
virtual

◆ SetupServiceFlow()

Member Data Documentation

◆ m_uplinkAllocations

std::list<OfdmUlMapIe> ns3::UplinkSchedulerSimple::m_uplinkAllocations
private

uplink allocations

Definition at line 155 of file bs-uplink-scheduler-simple.h.

Referenced by ~UplinkSchedulerSimple(), AddUplinkAllocation(), GetUplinkAllocations(), and Schedule().


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