This class implements the OFDM DCD channel encodings as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems". More...

#include "dl-mac-messages.h"

Inheritance diagram for ns3::OfdmDcdChannelEncodings:

Collaboration diagram for ns3::OfdmDcdChannelEncodings:

Public Member Functions
	OfdmDcdChannelEncodings ()

	~OfdmDcdChannelEncodings () override

Mac48Address	GetBaseStationId () const
	Get base station ID field.

uint8_t	GetChannelNr () const
	Get channel number field.

uint8_t	GetFrameDurationCode () const
	Get frame duration code field.

uint32_t	GetFrameNumber () const
	Get frame number field.

uint8_t	GetRtg () const
	Get RTG field.

uint16_t	GetSize () const
	Get size field.

uint8_t	GetTtg () const
	Get TTG field.

void	SetBaseStationId (Mac48Address baseStationId)
	Set base station ID field.

void	SetChannelNr (uint8_t channelNr)
	Set channel number field.

void	SetFrameDurationCode (uint8_t frameDurationCode)
	Set frame duration code field.

void	SetFrameNumber (uint32_t frameNumber)
	Set frame number field.

void	SetRtg (uint8_t rtg)
	Set RTG field.

void	SetTtg (uint8_t ttg)
	Set TTG field.

Public Member Functions inherited from ns3::DcdChannelEncodings
	DcdChannelEncodings ()

virtual	~DcdChannelEncodings ()

uint16_t	GetBsEirp () const
	Get BS EIRP field.

uint16_t	GetEirxPIrMax () const
	Get EIRX IR MAX field.

uint32_t	GetFrequency () const
	Get frequency function.

uint16_t	GetSize () const
	Get size field.

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

void	SetBsEirp (uint16_t bs_eirp)
	Set BS EIRP field.

void	SetEirxPIrMax (uint16_t rss_ir_max)
	Set EIRX IR MAX field.

void	SetFrequency (uint32_t frequency)
	Set frequency field.

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

Private Member Functions
Buffer::Iterator	DoRead (Buffer::Iterator start) override
	Read item.

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

Private Attributes
Mac48Address	m_baseStationId
	base station ID

uint8_t	m_channelNr
	channel number

uint8_t	m_frameDurationCode
	frame duration code

uint32_t	m_frameNumber
	frame number

uint8_t	m_rtg
	RTG.

uint8_t	m_ttg
	TTG.

Detailed Description

This class implements the OFDM DCD channel encodings as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems".

Definition at line 136 of file dl-mac-messages.h.

Constructor & Destructor Documentation

◆ OfdmDcdChannelEncodings()

ns3::OfdmDcdChannelEncodings::OfdmDcdChannelEncodings ( )

Definition at line 106 of file dl-mac-messages.cc.

◆ ~OfdmDcdChannelEncodings()

ns3::OfdmDcdChannelEncodings::~OfdmDcdChannelEncodings ( )

override

Definition at line 116 of file dl-mac-messages.cc.

Member Function Documentation

◆ DoRead()

Buffer::Iterator ns3::OfdmDcdChannelEncodings::DoRead ( Buffer::Iterator start )

overrideprivatevirtual

Read item.

Parameters

start the iterator

Returns: the updated iterator

Implements ns3::DcdChannelEncodings.

Definition at line 212 of file dl-mac-messages.cc.

References m_baseStationId, m_channelNr, m_frameDurationCode, m_frameNumber, m_rtg, m_ttg, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU32(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ DoWrite()

Buffer::Iterator ns3::OfdmDcdChannelEncodings::DoWrite ( Buffer::Iterator start ) const

overrideprivatevirtual

Write item.

Parameters

start the iterator

Returns: the updated iterator

Implements ns3::DcdChannelEncodings.

Definition at line 199 of file dl-mac-messages.cc.

References m_baseStationId, m_channelNr, m_frameDurationCode, m_frameNumber, m_rtg, m_ttg, ns3::WriteTo(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ GetBaseStationId()

Mac48Address ns3::OfdmDcdChannelEncodings::GetBaseStationId ( ) const

Get base station ID field.

Returns: the base station MAC address

Definition at line 175 of file dl-mac-messages.cc.

References m_baseStationId.

◆ GetChannelNr()

uint8_t ns3::OfdmDcdChannelEncodings::GetChannelNr ( ) const

Get channel number field.

Returns: the channel number

Definition at line 157 of file dl-mac-messages.cc.

References m_channelNr.

◆ GetFrameDurationCode()

uint8_t ns3::OfdmDcdChannelEncodings::GetFrameDurationCode ( ) const

Get frame duration code field.

Returns: the frame duration code

Definition at line 181 of file dl-mac-messages.cc.

References m_frameDurationCode.

Referenced by ns3::SubscriberStationNetDevice::ProcessDcd().

Here is the caller graph for this function:

◆ GetFrameNumber()

uint32_t ns3::OfdmDcdChannelEncodings::GetFrameNumber ( ) const

Get frame number field.

Returns: the frame number

Definition at line 187 of file dl-mac-messages.cc.

References m_frameNumber.

◆ GetRtg()

uint8_t ns3::OfdmDcdChannelEncodings::GetRtg ( ) const

Get RTG field.

Returns: the RTG

Definition at line 169 of file dl-mac-messages.cc.

References m_rtg.

◆ GetSize()

uint16_t ns3::OfdmDcdChannelEncodings::GetSize ( ) const

Get size field.

Returns: the size

Definition at line 193 of file dl-mac-messages.cc.

References ns3::DcdChannelEncodings::GetSize().

Referenced by ns3::Dcd::GetSerializedSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTtg()

uint8_t ns3::OfdmDcdChannelEncodings::GetTtg ( ) const

Get TTG field.

Returns: the TTG

Definition at line 163 of file dl-mac-messages.cc.

References m_ttg.

◆ SetBaseStationId()

void ns3::OfdmDcdChannelEncodings::SetBaseStationId ( Mac48Address baseStationId )

Set base station ID field.

Parameters

baseStationId the base station ID

Definition at line 139 of file dl-mac-messages.cc.

References m_baseStationId.

Referenced by ns3::BaseStationNetDevice::CreateDcd().

Here is the caller graph for this function:

◆ SetChannelNr()

void ns3::OfdmDcdChannelEncodings::SetChannelNr ( uint8_t channelNr )

Set channel number field.

Parameters

channelNr the channel number

Definition at line 121 of file dl-mac-messages.cc.

References m_channelNr.

Referenced by ns3::BaseStationNetDevice::CreateDcd().

Here is the caller graph for this function:

◆ SetFrameDurationCode()

void ns3::OfdmDcdChannelEncodings::SetFrameDurationCode ( uint8_t frameDurationCode )

Set frame duration code field.

Parameters

frameDurationCode the frame duration code

Definition at line 145 of file dl-mac-messages.cc.

References m_frameDurationCode.

Referenced by ns3::BaseStationNetDevice::CreateDcd().

Here is the caller graph for this function:

◆ SetFrameNumber()

void ns3::OfdmDcdChannelEncodings::SetFrameNumber ( uint32_t frameNumber )

Set frame number field.

Parameters

frameNumber the frame number

Definition at line 151 of file dl-mac-messages.cc.

References m_frameNumber.

Referenced by ns3::BaseStationNetDevice::CreateDcd().

Here is the caller graph for this function:

◆ SetRtg()

void ns3::OfdmDcdChannelEncodings::SetRtg ( uint8_t rtg )

Set RTG field.

Parameters

rtg the RTG

Definition at line 133 of file dl-mac-messages.cc.

References m_rtg.

Referenced by ns3::BaseStationNetDevice::CreateDcd().

Here is the caller graph for this function:

◆ SetTtg()

void ns3::OfdmDcdChannelEncodings::SetTtg ( uint8_t ttg )

Set TTG field.

Parameters

ttg the TTG

Definition at line 127 of file dl-mac-messages.cc.

References m_ttg.

Referenced by ns3::BaseStationNetDevice::CreateDcd().

Here is the caller graph for this function:

Member Data Documentation

◆ m_baseStationId

Mac48Address ns3::OfdmDcdChannelEncodings::m_baseStationId

private

base station ID

Definition at line 230 of file dl-mac-messages.h.

Referenced by DoRead(), DoWrite(), GetBaseStationId(), and SetBaseStationId().

◆ m_channelNr

uint8_t ns3::OfdmDcdChannelEncodings::m_channelNr

private

channel number

Definition at line 226 of file dl-mac-messages.h.

Referenced by DoRead(), DoWrite(), GetChannelNr(), and SetChannelNr().

◆ m_frameDurationCode

uint8_t ns3::OfdmDcdChannelEncodings::m_frameDurationCode

private

frame duration code

Definition at line 231 of file dl-mac-messages.h.

Referenced by DoRead(), DoWrite(), GetFrameDurationCode(), and SetFrameDurationCode().

◆ m_frameNumber

uint32_t ns3::OfdmDcdChannelEncodings::m_frameNumber

private

frame number

Definition at line 232 of file dl-mac-messages.h.

Referenced by DoRead(), DoWrite(), GetFrameNumber(), and SetFrameNumber().

◆ m_rtg

uint8_t ns3::OfdmDcdChannelEncodings::m_rtg

private

RTG.

Definition at line 228 of file dl-mac-messages.h.

Referenced by DoRead(), DoWrite(), GetRtg(), and SetRtg().

◆ m_ttg

uint8_t ns3::OfdmDcdChannelEncodings::m_ttg

private

TTG.

Definition at line 227 of file dl-mac-messages.h.

Referenced by DoRead(), DoWrite(), GetTtg(), and SetTtg().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OfdmDcdChannelEncodings()

◆ ~OfdmDcdChannelEncodings()

Member Function Documentation

◆ DoRead()

◆ DoWrite()

◆ GetBaseStationId()

◆ GetChannelNr()

◆ GetFrameDurationCode()

◆ GetFrameNumber()

◆ GetRtg()

◆ GetSize()

◆ GetTtg()

◆ SetBaseStationId()

◆ SetChannelNr()

◆ SetFrameDurationCode()

◆ SetFrameNumber()

◆ SetRtg()

◆ SetTtg()

Member Data Documentation

◆ m_baseStationId

◆ m_channelNr

◆ m_frameDurationCode

◆ m_frameNumber

◆ m_rtg

◆ m_ttg