A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::BSSchedulerSimple Class Reference

BaseStation Scheduler - simplified. More...

#include "bs-scheduler-simple.h"

+ Inheritance diagram for ns3::BSSchedulerSimple:
+ Collaboration diagram for ns3::BSSchedulerSimple:

Public Member Functions

 BSSchedulerSimple ()
 
 BSSchedulerSimple (Ptr< BaseStationNetDevice > bs)
 Constructor.
 
 ~BSSchedulerSimple () override
 
void AddDownlinkBurst (Ptr< const WimaxConnection > connection, uint8_t diuc, WimaxPhy::ModulationType modulationType, Ptr< PacketBurst > burst) override
 This function adds a downlink burst to the list of downlink bursts scheduled for the next downlink sub-frame.
 
Ptr< PacketBurstCreateUgsBurst (ServiceFlow *serviceFlow, WimaxPhy::ModulationType modulationType, uint32_t availableSymbols) override
 Creates a downlink UGS burst.
 
std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * GetDownlinkBursts () const override
 This function returns all the downlink bursts scheduled for the next downlink sub-frame.
 
void Schedule () override
 the scheduling function for the downlink subframe.
 
bool SelectConnection (Ptr< WimaxConnection > &connection) override
 Selects a connection from the list of connections having packets to be sent .
 
- Public Member Functions inherited from ns3::BSScheduler
 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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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::BSScheduler
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

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 - simplified.

Config Paths

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

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

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

Definition at line 47 of file bs-scheduler-simple.h.

Constructor & Destructor Documentation

◆ BSSchedulerSimple() [1/2]

ns3::BSSchedulerSimple::BSSchedulerSimple ( )

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

References ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

◆ BSSchedulerSimple() [2/2]

ns3::BSSchedulerSimple::BSSchedulerSimple ( Ptr< BaseStationNetDevice bs)

Constructor.

Parameters
bsbase station device

Definition at line 62 of file bs-scheduler-simple.cc.

References ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

◆ ~BSSchedulerSimple()

ns3::BSSchedulerSimple::~BSSchedulerSimple ( )
override

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

References m_downlinkBursts, and ns3::BSScheduler::SetBs().

+ Here is the call graph for this function:

Member Function Documentation

◆ AddDownlinkBurst()

void ns3::BSSchedulerSimple::AddDownlinkBurst ( Ptr< const WimaxConnection connection,
uint8_t  diuc,
WimaxPhy::ModulationType  modulationType,
Ptr< PacketBurst burst 
)
overridevirtual

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

Implements ns3::BSScheduler.

Definition at line 92 of file bs-scheduler-simple.cc.

References m_downlinkBursts, NS_LOG_INFO, and ns3::Cid::TRANSPORT.

Referenced by Schedule().

+ Here is the caller graph for this function:

◆ CreateUgsBurst()

Ptr< PacketBurst > ns3::BSSchedulerSimple::CreateUgsBurst ( ServiceFlow serviceFlow,
WimaxPhy::ModulationType  modulationType,
uint32_t  availableSymbols 
)
overridevirtual

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)

Implements ns3::BSScheduler.

Definition at line 360 of file bs-scheduler-simple.cc.

References ns3::BSScheduler::CheckForFragmentation(), ns3::BSScheduler::GetBs(), ns3::ServiceFlow::GetConnection(), ns3::ServiceFlow::HasPackets(), and ns3::MacHeaderType::HEADER_TYPE_GENERIC.

Referenced by Schedule().

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

◆ GetDownlinkBursts()

std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * ns3::BSSchedulerSimple::GetDownlinkBursts ( ) const
overridevirtual

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

Implements ns3::BSScheduler.

Definition at line 86 of file bs-scheduler-simple.cc.

References m_downlinkBursts.

◆ GetTypeId()

TypeId ns3::BSSchedulerSimple::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 47 of file bs-scheduler-simple.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Schedule()

void ns3::BSSchedulerSimple::Schedule ( )
overridevirtual

◆ SelectConnection()

bool ns3::BSSchedulerSimple::SelectConnection ( Ptr< WimaxConnection > &  connection)
overridevirtual

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

Implements ns3::BSScheduler.

Definition at line 242 of file bs-scheduler-simple.cc.

References ns3::Cid::BASIC, ns3::BSScheduler::GetBs(), ns3::ServiceFlowRecord::GetDlTimeStamp(), ns3::MilliSeconds(), ns3::Simulator::Now(), NS_LOG_INFO, ns3::Cid::PRIMARY, ns3::ServiceFlowRecord::SetDlTimeStamp(), ns3::ServiceFlow::SF_TYPE_BE, ns3::ServiceFlow::SF_TYPE_NRTPS, ns3::ServiceFlow::SF_TYPE_RTPS, and ns3::ServiceFlow::SF_TYPE_UGS.

Referenced by Schedule().

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

Member Data Documentation

◆ m_downlinkBursts

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

down link bursts

Definition at line 106 of file bs-scheduler-simple.h.

Referenced by ~BSSchedulerSimple(), AddDownlinkBurst(), GetDownlinkBursts(), and Schedule().


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