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

Profile manager for burst communications. More...

#include "burst-profile-manager.h"

+ Inheritance diagram for ns3::BurstProfileManager:
+ Collaboration diagram for ns3::BurstProfileManager:

Public Member Functions

 BurstProfileManager (const BurstProfileManager &)=delete
 
 BurstProfileManager (Ptr< WimaxNetDevice > device)
 Constructor.
 
 ~BurstProfileManager () override
 
void DoDispose () override
 Destructor implementation.
 
uint8_t GetBurstProfile (WimaxPhy::ModulationType modulationType, WimaxNetDevice::Direction direction) const
 returns the burst profile
 
uint8_t GetBurstProfileForSS (const SSRecord *ssRecord, const RngReq *rngreq, WimaxPhy::ModulationType &modulationType) const
 Get burst profile for SS.
 
uint8_t GetBurstProfileToRequest ()
 Get burst profile to request.
 
WimaxPhy::ModulationType GetModulationType (uint8_t iuc, WimaxNetDevice::Direction direction) const
 returns the modulation type of a given iuc
 
WimaxPhy::ModulationType GetModulationTypeForSS (const SSRecord *ssRecord, const RngReq *rngreq) const
 Get module ation type for SS.
 
uint16_t GetNrBurstProfilesToDefine ()
 
BurstProfileManageroperator= (const BurstProfileManager &)=delete
 
- 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::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< WimaxNetDevicem_device
 the device
 

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

Profile manager for burst communications.

Config Paths

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

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

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

Definition at line 40 of file burst-profile-manager.h.

Constructor & Destructor Documentation

◆ BurstProfileManager() [1/2]

ns3::BurstProfileManager::BurstProfileManager ( Ptr< WimaxNetDevice device)

Constructor.

Parameters
deviceWIMAX device

Definition at line 47 of file burst-profile-manager.cc.

◆ ~BurstProfileManager()

ns3::BurstProfileManager::~BurstProfileManager ( )
override

Definition at line 52 of file burst-profile-manager.cc.

References m_device.

◆ BurstProfileManager() [2/2]

ns3::BurstProfileManager::BurstProfileManager ( const BurstProfileManager )
delete

Member Function Documentation

◆ DoDispose()

void ns3::BurstProfileManager::DoDispose ( )
overridevirtual

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 58 of file burst-profile-manager.cc.

References m_device.

◆ GetBurstProfile()

uint8_t ns3::BurstProfileManager::GetBurstProfile ( WimaxPhy::ModulationType  modulationType,
WimaxNetDevice::Direction  direction 
) const

returns the burst profile

Parameters
modulationType
directionshould be uplink or downlink
Returns
the modulation type of the selected iuc

Definition at line 107 of file burst-profile-manager.cc.

References ns3::WimaxNetDevice::DIRECTION_DOWNLINK, m_device, and NS_FATAL_ERROR.

Referenced by GetBurstProfileForSS(), and GetBurstProfileToRequest().

+ Here is the caller graph for this function:

◆ GetBurstProfileForSS()

uint8_t ns3::BurstProfileManager::GetBurstProfileForSS ( const SSRecord ssRecord,
const RngReq rngreq,
WimaxPhy::ModulationType modulationType 
) const

Get burst profile for SS.

Parameters
modulationType
ssRecord
rngreq
Returns
the burst profile for SS

Definition at line 142 of file burst-profile-manager.cc.

References ns3::WimaxNetDevice::DIRECTION_DOWNLINK, GetBurstProfile(), and GetModulationTypeForSS().

+ Here is the call graph for this function:

◆ GetBurstProfileToRequest()

uint8_t ns3::BurstProfileManager::GetBurstProfileToRequest ( )

Get burst profile to request.

Returns
the burst profile for SS

Definition at line 161 of file burst-profile-manager.cc.

References ns3::WimaxNetDevice::DIRECTION_DOWNLINK, GetBurstProfile(), ns3::SubscriberStationNetDevice::GetModulationType(), and m_device.

+ Here is the call graph for this function:

◆ GetModulationType()

WimaxPhy::ModulationType ns3::BurstProfileManager::GetModulationType ( uint8_t  iuc,
WimaxNetDevice::Direction  direction 
) const

returns the modulation type of a given iuc

Parameters
directionshould be uplink or downlink
iucthe iuc
Returns
the modulation type of the selected iuc

Definition at line 73 of file burst-profile-manager.cc.

References ns3::WimaxNetDevice::DIRECTION_DOWNLINK, m_device, and NS_FATAL_ERROR.

Referenced by GetModulationTypeForSS().

+ Here is the caller graph for this function:

◆ GetModulationTypeForSS()

WimaxPhy::ModulationType ns3::BurstProfileManager::GetModulationTypeForSS ( const SSRecord ssRecord,
const RngReq rngreq 
) const

Get module ation type for SS.

Parameters
ssRecord
rngreq
Returns
the burst profile for SS

Definition at line 155 of file burst-profile-manager.cc.

References ns3::WimaxNetDevice::DIRECTION_DOWNLINK, GetModulationType(), and ns3::RngReq::GetReqDlBurstProfile().

Referenced by GetBurstProfileForSS().

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

◆ GetNrBurstProfilesToDefine()

uint16_t ns3::BurstProfileManager::GetNrBurstProfilesToDefine ( )
Returns
the number of available burst profile

Definition at line 64 of file burst-profile-manager.cc.

◆ GetTypeId()

TypeId ns3::BurstProfileManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 40 of file burst-profile-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

BurstProfileManager & ns3::BurstProfileManager::operator= ( const BurstProfileManager )
delete

Member Data Documentation

◆ m_device

Ptr<WimaxNetDevice> ns3::BurstProfileManager::m_device
private

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