A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::BSScheduler Class Referenceabstract

BaseStation Scheduler. More...

#include "bs-scheduler.h"

+ Inheritance diagram for ns3::BSScheduler:
+ Collaboration diagram for ns3::BSScheduler:

Public Member Functions

 BSScheduler ()
 
 BSScheduler (Ptr< BaseStationNetDevice > bs)
 Constructor.
 
 ~BSScheduler () override
 
virtual void AddDownlinkBurst (Ptr< const WimaxConnection > connection, uint8_t diuc, WimaxPhy::ModulationType modulationType, Ptr< PacketBurst > burst)=0
 This function adds a downlink burst to the list of downlink bursts scheduled for the next downlink sub-frame.
 
bool CheckForFragmentation (Ptr< WimaxConnection > connection, int availableSymbols, WimaxPhy::ModulationType modulationType)
 Check if the packet fragmentation is possible for transport connection.
 
virtual Ptr< PacketBurstCreateUgsBurst (ServiceFlow *serviceFlow, WimaxPhy::ModulationType modulationType, uint32_t availableSymbols)=0
 Creates a downlink UGS burst.
 
virtual Ptr< BaseStationNetDeviceGetBs ()
 Get the base station.
 
virtual std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * GetDownlinkBursts () const =0
 This function returns all the downlink bursts scheduled for the next downlink sub-frame.
 
virtual void Schedule ()=0
 the scheduling function for the downlink subframe.
 
virtual bool SelectConnection (Ptr< WimaxConnection > &connection)=0
 Selects a connection from the list of connections having packets to be sent .
 
virtual void SetBs (Ptr< BaseStationNetDevice > bs)
 Set the base station.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

Ptr< BaseStationNetDevicem_bs
 base station
 
std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * m_downlinkBursts
 down link bursts
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

BaseStation Scheduler.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BSScheduler"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/Scheduler"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BSScheduler"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/Scheduler"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wimax

Size of this type is 72 bytes (on a 64-bit architecture).

Definition at line 36 of file bs-scheduler.h.

Constructor & Destructor Documentation

◆ BSScheduler() [1/2]

ns3::BSScheduler::BSScheduler ( )

Definition at line 44 of file bs-scheduler.cc.

◆ BSScheduler() [2/2]

ns3::BSScheduler::BSScheduler ( Ptr< BaseStationNetDevice > bs)

Constructor.

Parameters
bsbase station device

Definition at line 51 of file bs-scheduler.cc.

◆ ~BSScheduler()

ns3::BSScheduler::~BSScheduler ( )
override

Definition at line 56 of file bs-scheduler.cc.

References m_downlinkBursts, and SetBs().

+ Here is the call graph for this function:

Member Function Documentation

◆ AddDownlinkBurst()

virtual void ns3::BSScheduler::AddDownlinkBurst ( Ptr< const WimaxConnection > connection,
uint8_t diuc,
WimaxPhy::ModulationType modulationType,
Ptr< PacketBurst > burst )
pure virtual

This function adds a downlink burst to the list of downlink bursts scheduled for the next downlink sub-frame.

Parameters
connectiona pointer to connection in which the burst will be sent
diucdownlink iuc
modulationTypethe modulation type of the burst
burstthe downlink burst to add to the downlink sub frame

Implemented in ns3::BSSchedulerRtps, and ns3::BSSchedulerSimple.

◆ CheckForFragmentation()

bool ns3::BSScheduler::CheckForFragmentation ( Ptr< WimaxConnection > connection,
int availableSymbols,
WimaxPhy::ModulationType modulationType )

Check if the packet fragmentation is possible for transport connection.

Parameters
connectionthe downlink connection
availableSymbolsmaximum number of OFDM symbols to be used by the burst
modulationTypethe modulation type to be used for the burst
Returns
false if packet fragmentation is not possible, true otherwise

Definition at line 84 of file bs-scheduler.cc.

References GetBs(), ns3::MacHeaderType::HEADER_TYPE_GENERIC, NS_LOG_INFO, and ns3::Cid::TRANSPORT.

Referenced by ns3::BSSchedulerRtps::BSSchedulerBasicConnection(), ns3::BSSchedulerRtps::BSSchedulerBroadcastConnection(), ns3::BSSchedulerRtps::BSSchedulerInitialRangingConnection(), ns3::BSSchedulerRtps::BSSchedulerPrimaryConnection(), ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), ns3::BSSchedulerRtps::CreateUgsBurst(), ns3::BSSchedulerSimple::CreateUgsBurst(), and ns3::BSSchedulerSimple::Schedule().

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

◆ CreateUgsBurst()

virtual Ptr< PacketBurst > ns3::BSScheduler::CreateUgsBurst ( ServiceFlow * serviceFlow,
WimaxPhy::ModulationType modulationType,
uint32_t availableSymbols )
pure virtual

Creates a downlink UGS burst.

Parameters
serviceFlowthe service flow of the burst
modulationTypethe modulation type to be used for the burst
availableSymbolsmaximum number of OFDM symbols to be used by the burst
Returns
a Burst (list of packets)

Implemented in ns3::BSSchedulerRtps, and ns3::BSSchedulerSimple.

◆ GetBs()

◆ GetDownlinkBursts()

virtual std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * ns3::BSScheduler::GetDownlinkBursts ( ) const
pure virtual

This function returns all the downlink bursts scheduled for the next downlink sub-frame.

Returns
all the downlink bursts scheduled for the next downlink sub-frame

Implemented in ns3::BSSchedulerRtps, and ns3::BSSchedulerSimple.

◆ GetTypeId()

TypeId ns3::BSScheduler::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 36 of file bs-scheduler.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Schedule()

virtual void ns3::BSScheduler::Schedule ( )
pure virtual

the scheduling function for the downlink subframe.

Implemented in ns3::BSSchedulerRtps, and ns3::BSSchedulerSimple.

◆ SelectConnection()

virtual bool ns3::BSScheduler::SelectConnection ( Ptr< WimaxConnection > & connection)
pure virtual

Selects a connection from the list of connections having packets to be sent .

Parameters
connectionwill point to a connection that have packets to be sent
Returns
false if no connection has packets to be sent, true otherwise

Implemented in ns3::BSSchedulerRtps, and ns3::BSSchedulerSimple.

◆ SetBs()

void ns3::BSScheduler::SetBs ( Ptr< BaseStationNetDevice > bs)
virtual

Set the base station.

Parameters
bsthe base station net device

Definition at line 72 of file bs-scheduler.cc.

References m_bs.

Referenced by ns3::BSSchedulerRtps::BSSchedulerRtps(), ns3::BSSchedulerRtps::BSSchedulerRtps(), ns3::BSSchedulerSimple::BSSchedulerSimple(), ns3::BSSchedulerSimple::BSSchedulerSimple(), ~BSScheduler(), ns3::BSSchedulerRtps::~BSSchedulerRtps(), and ns3::BSSchedulerSimple::~BSSchedulerSimple().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_bs

Ptr<BaseStationNetDevice> ns3::BSScheduler::m_bs
private

base station

Definition at line 118 of file bs-scheduler.h.

Referenced by GetBs(), and SetBs().

◆ m_downlinkBursts

std::list<std::pair<OfdmDlMapIe*, Ptr<PacketBurst> > >* ns3::BSScheduler::m_downlinkBursts
private

down link bursts

Definition at line 119 of file bs-scheduler.h.

Referenced by ~BSScheduler().


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