A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::BSScheduler Class Referenceabstract


More...

#include "bs-scheduler.h"

+ Inheritance diagram for ns3::BSScheduler:

Public Member Functions

 BSScheduler ()
 
 BSScheduler (Ptr< BaseStationNetDevice > bs)
 Constructor. More...
 
 ~BSScheduler (void)
 
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. More...
 
bool CheckForFragmentation (Ptr< WimaxConnection > connection, int availableSymbols, WimaxPhy::ModulationType modulationType)
 Check if the packet fragmentation is possible for transport connection. More...
 
virtual Ptr< PacketBurstCreateUgsBurst (ServiceFlow *serviceFlow, WimaxPhy::ModulationType modulationType, uint32_t availableSymbols)=0
 Creates a downlink UGS burst. More...
 
virtual Ptr< BaseStationNetDeviceGetBs (void)
 Get the base station. More...
 
virtual std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * GetDownlinkBursts (void) const =0
 This function returns all the downlink bursts scheduled for the next downlink sub-frame. More...
 
virtual void Schedule (void)=0
 the scheduling function for the downlink subframe. More...
 
virtual bool SelectConnection (Ptr< WimaxConnection > &connection)=0
 Selects a connection from the list of connections having packets to be sent . More...
 
virtual void SetBs (Ptr< BaseStationNetDevice > bs)
 Set the base station. 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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...
 
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

Ptr< BaseStationNetDevicem_bs
 base station More...
 
std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * m_downlinkBursts
 down link bursts 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


Config Paths

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

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

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

Constructor & Destructor Documentation

◆ BSScheduler() [1/2]

ns3::BSScheduler::BSScheduler ( )

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

◆ BSScheduler() [2/2]

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

Constructor.

Parameters
bsbase station device

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

◆ ~BSScheduler()

ns3::BSScheduler::~BSScheduler ( void  )

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

References m_downlinkBursts, and SetBs().

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 95 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::BSSchedulerSimple::CreateUgsBurst(), ns3::BSSchedulerRtps::CreateUgsBurst(), and ns3::BSSchedulerSimple::Schedule().

◆ 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()

Ptr< BaseStationNetDevice > ns3::BSScheduler::GetBs ( void  )
virtual

◆ GetDownlinkBursts()

virtual std::list<std::pair<OfdmDlMapIe*, Ptr<PacketBurst> > >* ns3::BSScheduler::GetDownlinkBursts ( void  ) 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 ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

◆ Schedule()

virtual void ns3::BSScheduler::Schedule ( void  )
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 84 of file bs-scheduler.cc.

References m_bs.

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

Member Data Documentation

◆ m_bs

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

base station

Definition at line 125 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 126 of file bs-scheduler.h.

Referenced by ~BSScheduler().


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