#include "burst-profile-manager.h"

Inheritance diagram for ns3::BurstProfileManager:

Public Member Functions
	BurstProfileManager (Ptr< WimaxNetDevice > device)
	Constructor. More...

	~BurstProfileManager (void)

void	DoDispose (void)
	Destructor implementation. More...

uint8_t	GetBurstProfile (WimaxPhy::ModulationType modulationType, WimaxNetDevice::Direction direction) const
	returns the burst profile More...

uint8_t	GetBurstProfileForSS (const SSRecord ssRecord, const RngReq rngreq, WimaxPhy::ModulationType &modulationType)
	Get burst profile for SS. More...

uint8_t	GetBurstProfileToRequest (void)
	Get burst profile to request. More...

WimaxPhy::ModulationType	GetModulationType (uint8_t iuc, WimaxNetDevice::Direction direction) const
	returns the modulation type of a given iuc More...

WimaxPhy::ModulationType	GetModulationTypeForSS (const SSRecord ssRecord, const RngReq rngreq)
	Get module ation type for SS. More...

uint16_t	GetNrBurstProfilesToDefine (void)

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

SimpleRefCount &	operator= (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
	BurstProfileManager (const BurstProfileManager &)
	Type conversion operator. More...

BurstProfileManager &	operator= (const BurstProfileManager &)
	Assignment operator. More...

Private Attributes
Ptr< WimaxNetDevice >	m_device
	the device 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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

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 40 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ BurstProfileManager() [1/2]

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

Constructor.

Parameters

device WIMAX device

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

◆ ~BurstProfileManager()

ns3::BurstProfileManager::~BurstProfileManager ( void )

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

References m_device.

◆ BurstProfileManager() [2/2]

ns3::BurstProfileManager::BurstProfileManager ( const BurstProfileManager & )

private

Type conversion operator.

Member Function Documentation

◆ DoDispose()

void ns3::BurstProfileManager::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 55 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
direction	should 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().

◆ GetBurstProfileForSS()

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

Get burst profile for SS.

Parameters

modulationType
ssRecord
rngreq

Returns: the burst profile for SS

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

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

◆ GetBurstProfileToRequest()

uint8_t ns3::BurstProfileManager::GetBurstProfileToRequest ( void )

Get burst profile to request.

Returns: the burst profile for SS

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

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

◆ GetModulationType()

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

returns the modulation type of a given iuc

Parameters

direction	should be uplink or downlink
iuc	the iuc

Returns: the modulation type of the selected iuc

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

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

Referenced by GetModulationTypeForSS().

◆ GetModulationTypeForSS()

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

Get module ation type for SS.

Parameters

ssRecord
rngreq

Returns: the burst profile for SS

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

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

Referenced by GetBurstProfileForSS().

◆ GetNrBurstProfilesToDefine()

uint16_t ns3::BurstProfileManager::GetNrBurstProfilesToDefine ( void )

Returns: the number of available burst profile

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

◆ GetTypeId()

TypeId ns3::BurstProfileManager::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

◆ operator=()

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

private

Assignment operator.

Returns: burst profile manager

Member Data Documentation

◆ m_device

Ptr<WimaxNetDevice> ns3::BurstProfileManager::m_device

private

the device

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

Referenced by DoDispose(), GetBurstProfile(), GetBurstProfileToRequest(), GetModulationType(), and ~BurstProfileManager().

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

src/wimax/model/burst-profile-manager.h
src/wimax/model/burst-profile-manager.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Constructor & Destructor Documentation

◆ BurstProfileManager() [1/2]

◆ ~BurstProfileManager()

◆ BurstProfileManager() [2/2]

Member Function Documentation

◆ DoDispose()

◆ GetBurstProfile()

◆ GetBurstProfileForSS()

◆ GetBurstProfileToRequest()

◆ GetModulationType()

◆ GetModulationTypeForSS()

◆ GetNrBurstProfilesToDefine()

◆ GetTypeId()

◆ operator=()

Member Data Documentation

◆ m_device