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

#include "ss-scheduler.h"

+ Inheritance diagram for ns3::SSScheduler:
+ Collaboration diagram for ns3::SSScheduler:

Public Member Functions

 SSScheduler (Ptr< SubscriberStationNetDevice > ss)
 Constructor. More...
 
 ~SSScheduler (void)
 
void DoDispose (void)
 Destructor implementation. More...
 
bool GetPollMe (void) const
 Get the poll me value. More...
 
Ptr< PacketBurstSchedule (uint16_t availableSymbols, WimaxPhy::ModulationType modulationType, MacHeaderType::HeaderType packetType, Ptr< WimaxConnection > &connection)
 
void SetPollMe (bool pollMe)
 Set poll me value. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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 Member Functions

 SSScheduler (const SSScheduler &)
 type conversion operator More...
 
SSScheduleroperator= (const SSScheduler &)
 assignment operator More...
 
Ptr< WimaxConnectionSelectConnection (void)
 Select connection. More...
 

Private Attributes

bool m_pollMe
 poll me flag More...
 
Ptr< SubscriberStationNetDevicem_ss
 the subscriber station More...
 

Additional Inherited Members

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

Parameters
SSSchedulerclass

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler"

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 41 of file ss-scheduler.h.

Constructor & Destructor Documentation

◆ SSScheduler() [1/2]

ns3::SSScheduler::SSScheduler ( Ptr< SubscriberStationNetDevice ss)

Constructor.

Parameters
sssubscriber station device

Definition at line 48 of file ss-scheduler.cc.

◆ ~SSScheduler()

ns3::SSScheduler::~SSScheduler ( void  )

Definition at line 54 of file ss-scheduler.cc.

◆ SSScheduler() [2/2]

ns3::SSScheduler::SSScheduler ( const SSScheduler )
private

type conversion operator

Member Function Documentation

◆ DoDispose()

void ns3::SSScheduler::DoDispose ( void  )
virtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 59 of file ss-scheduler.cc.

References m_ss.

◆ GetPollMe()

bool ns3::SSScheduler::GetPollMe ( void  ) const

Get the poll me value.

Returns
the poll me flag

Definition at line 71 of file ss-scheduler.cc.

References m_pollMe.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 40 of file ss-scheduler.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

SSScheduler& ns3::SSScheduler::operator= ( const SSScheduler )
private

assignment operator

Returns
the SS scheduler

◆ Schedule()

Ptr< PacketBurst > ns3::SSScheduler::Schedule ( uint16_t  availableSymbols,
WimaxPhy::ModulationType  modulationType,
MacHeaderType::HeaderType  packetType,
Ptr< WimaxConnection > &  connection 
)
Returns
a list of packet to be sent in the next opportunity
Parameters
availableSymbolsthe available resources in symbols
modulationTypethe used modulation
packetTypethe type of packets to select from
connectionthe connection from which packets will be selected

Definition at line 77 of file ss-scheduler.cc.

References ns3::Packet::GetSize(), m_ss, NS_ASSERT_MSG, NS_LOG_INFO, SelectConnection(), and ns3::Cid::TRANSPORT.

+ Here is the call graph for this function:

◆ SelectConnection()

Ptr< WimaxConnection > ns3::SSScheduler::SelectConnection ( void  )
private

Select connection.

Returns
pointer to the wimax connection

Definition at line 167 of file ss-scheduler.cc.

References ns3::MacHeaderType::HEADER_TYPE_GENERIC, m_ss, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_LOG_INFO, 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:

◆ SetPollMe()

void ns3::SSScheduler::SetPollMe ( bool  pollMe)

Set poll me value.

Parameters
pollMethe poll me flag

Definition at line 65 of file ss-scheduler.cc.

References m_pollMe.

Member Data Documentation

◆ m_pollMe

bool ns3::SSScheduler::m_pollMe
private

poll me flag

Definition at line 97 of file ss-scheduler.h.

Referenced by GetPollMe(), and SetPollMe().

◆ m_ss

Ptr<SubscriberStationNetDevice> ns3::SSScheduler::m_ss
private

the subscriber station

Definition at line 96 of file ss-scheduler.h.

Referenced by DoDispose(), Schedule(), and SelectConnection().


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