This class implements the UL-MAP_IE message as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.43.7 UL-MAP_IE, page 115. More...

#include "ul-mac-messages.h"

Collaboration diagram for ns3::OfdmUlMapIe:

Public Member Functions
	OfdmUlMapIe ()

	~OfdmUlMapIe ()

Cid	GetCid () const
	Get CID.

uint16_t	GetDuration () const
	Get duration.

uint8_t	GetMidambleRepetitionInterval () const
	Get Midamble repetition interval.

uint16_t	GetSize () const
	Get size.

uint16_t	GetStartTime () const
	Get start time.

uint8_t	GetSubchannelIndex () const
	Get subchannel index.

uint8_t	GetUiuc () const
	Get UIUC.

Buffer::Iterator	Read (Buffer::Iterator start)
	Read item.

void	SetCid (const Cid &cid)
	Set CID.

void	SetDuration (uint16_t duration)
	Set duration.

void	SetMidambleRepetitionInterval (uint8_t midambleRepetitionInterval)
	Set midambe repetition interval.

void	SetStartTime (uint16_t startTime)
	Set start time.

void	SetSubchannelIndex (uint8_t subchannelIndex)
	Set subchannel index.

void	SetUiuc (uint8_t uiuc)
	Set UIUC.

Buffer::Iterator	Write (Buffer::Iterator start) const
	Write item.

Private Attributes
Cid	m_cid
	CID.

uint16_t	m_duration
	duration

uint8_t	m_midambleRepetitionInterval
	midamble repetition interval

uint16_t	m_startTime
	start time

uint8_t	m_subchannelIndex
	subchannel index

uint8_t	m_uiuc
	UIUC.

Detailed Description

This class implements the UL-MAP_IE message as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.43.7 UL-MAP_IE, page 115.

Definition at line 463 of file ul-mac-messages.h.

Constructor & Destructor Documentation

◆ OfdmUlMapIe()

ns3::OfdmUlMapIe::OfdmUlMapIe ( )

Definition at line 451 of file ul-mac-messages.cc.

◆ ~OfdmUlMapIe()

ns3::OfdmUlMapIe::~OfdmUlMapIe ( )

Definition at line 461 of file ul-mac-messages.cc.

Member Function Documentation

◆ GetCid()

Cid ns3::OfdmUlMapIe::GetCid ( ) const

Get CID.

Returns: the CID

Definition at line 502 of file ul-mac-messages.cc.

References m_cid.

Referenced by ns3::BaseStationNetDevice::MarkUplinkAllocations(), and ns3::SubscriberStationNetDevice::ProcessUlMap().

Here is the caller graph for this function:

◆ GetDuration()

uint16_t ns3::OfdmUlMapIe::GetDuration ( ) const

Get duration.

Returns: the duration

Definition at line 526 of file ul-mac-messages.cc.

References m_duration.

Referenced by ns3::BaseStationNetDevice::MarkUplinkAllocations(), and ns3::SubscriberStationNetDevice::ProcessUlMap().

Here is the caller graph for this function:

◆ GetMidambleRepetitionInterval()

uint8_t ns3::OfdmUlMapIe::GetMidambleRepetitionInterval ( ) const

Get Midamble repetition interval.

Returns: the midamble repetition interval

Definition at line 532 of file ul-mac-messages.cc.

References m_midambleRepetitionInterval.

◆ GetSize()

uint16_t ns3::OfdmUlMapIe::GetSize ( ) const

Get size.

Returns: the size

Definition at line 538 of file ul-mac-messages.cc.

◆ GetStartTime()

uint16_t ns3::OfdmUlMapIe::GetStartTime ( ) const

Get start time.

Returns: the start time

Definition at line 508 of file ul-mac-messages.cc.

References m_startTime.

Referenced by ns3::BaseStationNetDevice::MarkUplinkAllocations(), and ns3::SubscriberStationNetDevice::ProcessUlMap().

Here is the caller graph for this function:

◆ GetSubchannelIndex()

uint8_t ns3::OfdmUlMapIe::GetSubchannelIndex ( ) const

Get subchannel index.

Returns: the subchannel index

Definition at line 514 of file ul-mac-messages.cc.

References m_subchannelIndex.

◆ GetUiuc()

uint8_t ns3::OfdmUlMapIe::GetUiuc ( ) const

Get UIUC.

Returns: the UIUC

Definition at line 520 of file ul-mac-messages.cc.

References m_uiuc.

Referenced by ns3::UlMap::Deserialize(), ns3::BaseStationNetDevice::MarkUplinkAllocations(), ns3::SubscriberStationNetDevice::ProcessUlMap(), ns3::UplinkSchedulerMBQoS::ServiceUnsolicitedGrants(), ns3::UplinkSchedulerRtps::ServiceUnsolicitedGrants(), and ns3::UplinkSchedulerSimple::ServiceUnsolicitedGrants().

Here is the caller graph for this function:

◆ Read()

Buffer::Iterator ns3::OfdmUlMapIe::Read ( Buffer::Iterator start )

Read item.

Parameters

start the iterator

Returns: the updated iterator

Definition at line 557 of file ul-mac-messages.cc.

References m_cid, m_duration, m_midambleRepetitionInterval, m_startTime, m_subchannelIndex, m_uiuc, ns3::Buffer::Iterator::ReadU16(), and ns3::Buffer::Iterator::ReadU8().

Referenced by ns3::UlMap::Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCid()

void ns3::OfdmUlMapIe::SetCid ( const Cid & cid )

Set CID.

Parameters

cid the CID

Definition at line 466 of file ul-mac-messages.cc.

References m_cid.

Referenced by ns3::UplinkSchedulerMBQoS::AllocateInitialRangingInterval(), ns3::UplinkSchedulerRtps::AllocateInitialRangingInterval(), ns3::UplinkSchedulerSimple::AllocateInitialRangingInterval(), ns3::UplinkSchedulerMBQoS::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::UplinkSchedulerSimple::Schedule(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().

Here is the caller graph for this function:

◆ SetDuration()

void ns3::OfdmUlMapIe::SetDuration ( uint16_t duration )

Set duration.

Parameters

duration the duration

Definition at line 490 of file ul-mac-messages.cc.

References m_duration.

Referenced by ns3::UplinkSchedulerMBQoS::AddUplinkAllocation(), ns3::UplinkSchedulerRtps::AddUplinkAllocation(), ns3::UplinkSchedulerSimple::AddUplinkAllocation(), ns3::UplinkSchedulerMBQoS::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), and ns3::UplinkSchedulerSimple::Schedule().

Here is the caller graph for this function:

◆ SetMidambleRepetitionInterval()

void ns3::OfdmUlMapIe::SetMidambleRepetitionInterval ( uint8_t midambleRepetitionInterval )

Set midambe repetition interval.

Parameters

midambleRepetitionInterval the midambe repetition interval

Definition at line 496 of file ul-mac-messages.cc.

References m_midambleRepetitionInterval.

◆ SetStartTime()

void ns3::OfdmUlMapIe::SetStartTime ( uint16_t startTime )

Set start time.

Parameters

startTime the start time

Definition at line 472 of file ul-mac-messages.cc.

References m_startTime.

Here is the caller graph for this function:

◆ SetSubchannelIndex()

void ns3::OfdmUlMapIe::SetSubchannelIndex ( uint8_t subchannelIndex )

Set subchannel index.

Parameters

subchannelIndex

Definition at line 478 of file ul-mac-messages.cc.

References m_subchannelIndex.

◆ SetUiuc()

void ns3::OfdmUlMapIe::SetUiuc ( uint8_t uiuc )

Set UIUC.

Parameters

uiuc the UIUC

Definition at line 484 of file ul-mac-messages.cc.

References m_uiuc.

Here is the caller graph for this function:

◆ Write()

Buffer::Iterator ns3::OfdmUlMapIe::Write ( Buffer::Iterator start ) const

Write item.

Parameters

start the iterator

Returns: the updated iterator

Definition at line 544 of file ul-mac-messages.cc.

References ns3::Cid::GetIdentifier(), m_cid, m_duration, m_midambleRepetitionInterval, m_startTime, m_subchannelIndex, m_uiuc, ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

Member Data Documentation

◆ m_cid

Cid ns3::OfdmUlMapIe::m_cid

private

CID.

Definition at line 551 of file ul-mac-messages.h.

Referenced by GetCid(), Read(), SetCid(), and Write().

◆ m_duration

uint16_t ns3::OfdmUlMapIe::m_duration

private

duration

Definition at line 555 of file ul-mac-messages.h.

Referenced by GetDuration(), Read(), SetDuration(), and Write().

◆ m_midambleRepetitionInterval

uint8_t ns3::OfdmUlMapIe::m_midambleRepetitionInterval

private

midamble repetition interval

Definition at line 556 of file ul-mac-messages.h.

Referenced by GetMidambleRepetitionInterval(), Read(), SetMidambleRepetitionInterval(), and Write().

◆ m_startTime

uint16_t ns3::OfdmUlMapIe::m_startTime

private

start time

Definition at line 552 of file ul-mac-messages.h.

Referenced by GetStartTime(), Read(), SetStartTime(), and Write().

◆ m_subchannelIndex

uint8_t ns3::OfdmUlMapIe::m_subchannelIndex

private

subchannel index

Definition at line 553 of file ul-mac-messages.h.

Referenced by GetSubchannelIndex(), Read(), SetSubchannelIndex(), and Write().

◆ m_uiuc

uint8_t ns3::OfdmUlMapIe::m_uiuc

private

UIUC.

Definition at line 554 of file ul-mac-messages.h.

Referenced by GetUiuc(), Read(), SetUiuc(), and Write().

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

src/wimax/model/ul-mac-messages.h
src/wimax/model/ul-mac-messages.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OfdmUlMapIe()

◆ ~OfdmUlMapIe()

Member Function Documentation

◆ GetCid()

◆ GetDuration()

◆ GetMidambleRepetitionInterval()

◆ GetSize()

◆ GetStartTime()

◆ GetSubchannelIndex()

◆ GetUiuc()

◆ Read()

◆ SetCid()

◆ SetDuration()

◆ SetMidambleRepetitionInterval()

◆ SetStartTime()

◆ SetSubchannelIndex()

◆ SetUiuc()

◆ Write()

Member Data Documentation

◆ m_cid

◆ m_duration

◆ m_midambleRepetitionInterval

◆ m_startTime

◆ m_subchannelIndex

◆ m_uiuc