Doxygen introspection did not find any typical Config paths. More...

#include <mac-messages.h>

Inheritance diagram for ns3::RngRsp:

Collaboration diagram for ns3::RngRsp:

Public Member Functions
	RngRsp (void)
	This class implements the ranging response message described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.6 Ranging response (RNG-RSP) message, page 50. More...

virtual	~RngRsp (void)

uint32_t	Deserialize (Buffer::Iterator start)

uint8_t	GetAasBdcastPermission (void) const

Cid	GetBasicCid (void) const

uint32_t	GetDlFreqOverride (void) const

uint16_t	GetDlOperBurstProfile (void) const

uint32_t	GetFrameNumber (void) const

uint8_t	GetInitRangOppNumber (void) const

virtual TypeId	GetInstanceTypeId (void) const

Mac48Address	GetMacAddress (void) const

std::string	GetName (void) const

uint32_t	GetOffsetFreqAdjust (void) const

uint8_t	GetPowerLevelAdjust (void) const

Cid	GetPrimaryCid (void) const

uint8_t	GetRangStatus (void) const

uint8_t	GetRangSubchnl (void) const

uint32_t	GetSerializedSize (void) const

uint32_t	GetTimingAdjust (void) const

uint8_t	GetUlChnlIdOverride (void) const

void	Print (std::ostream &os) const

void	Serialize (Buffer::Iterator start) const

void	SetAasBdcastPermission (uint8_t aasBdcastPermission)

void	SetBasicCid (Cid basicCid)

void	SetDlFreqOverride (uint32_t dlFreqOverride)
	set the Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging. More...

void	SetDlOperBurstProfile (uint16_t dlOperBurstProfile)

void	SetFrameNumber (uint32_t frameNumber)

void	SetInitRangOppNumber (uint8_t initRangOppNumber)

void	SetMacAddress (Mac48Address macAddress)

void	SetOffsetFreqAdjust (uint32_t offsetFreqAdjust)
	set the relative change in transmission frequency that the SS should take in order to better match the BS. More...

void	SetPowerLevelAdjust (uint8_t powerLevelAdjust)
	set the relative change in transmission power level that the SS should make in order that transmissions arrive at the BS at the desired power. More...

void	SetPrimaryCid (Cid primaryCid)

void	SetRangStatus (uint8_t rangStatus)

void	SetRangSubchnl (uint8_t rangSubchnl)

void	SetTimingAdjust (uint32_t timingAdjust)
	set the Tx timing offset adjustment (signed 32-bit). More...

void	SetUlChnlIdOverride (uint8_t ulChnlIdOverride)
	set the identifier of the uplink channel with which the SS is to redo initial ranging More...

Public Member Functions inherited from ns3::Header
virtual	~Header ()

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
uint8_t	m_aasBdcastPermission

Cid	m_basicCid

uint32_t	m_dlFreqOverride

uint16_t	m_dlOperBurstProfile

uint32_t	m_frameNumber

uint8_t	m_initRangOppNumber

Mac48Address	m_macAddress

uint32_t	m_offsetFreqAdjust

uint8_t	m_powerLevelAdjust

Cid	m_primaryCid

uint8_t	m_rangStatus

uint8_t	m_rangSubchnl

uint8_t	m_reserved

uint32_t	m_timingAdjust

uint8_t	m_ulChnlIdOverride

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Doxygen introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 97 of file mac-messages.h.

Constructor & Destructor Documentation

ns3::RngRsp::RngRsp ( void )

This class implements the ranging response message described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.6 Ranging response (RNG-RSP) message, page 50.

Definition at line 228 of file mac-messages.cc.

ns3::RngRsp::~RngRsp ( void )

virtual

Definition at line 247 of file mac-messages.cc.

Member Function Documentation

uint32_t ns3::RngRsp::Deserialize ( Buffer::Iterator start )

virtual

Parameters

start an iterator which points to where the header should written.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Implements ns3::Header.

Definition at line 479 of file mac-messages.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_aasBdcastPermission, m_basicCid, m_dlFreqOverride, m_dlOperBurstProfile, m_frameNumber, m_initRangOppNumber, m_macAddress, m_offsetFreqAdjust, m_powerLevelAdjust, m_primaryCid, m_rangStatus, m_rangSubchnl, m_reserved, m_timingAdjust, m_ulChnlIdOverride, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU32(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

uint8_t ns3::RngRsp::GetAasBdcastPermission ( void ) const

Definition at line 396 of file mac-messages.cc.

References m_aasBdcastPermission.

Cid ns3::RngRsp::GetBasicCid ( void ) const

Definition at line 384 of file mac-messages.cc.

References m_basicCid.

Referenced by ns3::SSLinkManager::PerformRanging().

Here is the caller graph for this function:

uint32_t ns3::RngRsp::GetDlFreqOverride ( void ) const

Returns: Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging.

Definition at line 360 of file mac-messages.cc.

References m_dlFreqOverride.

Referenced by ns3::SSLinkManager::PerformRanging().

Here is the caller graph for this function:

uint16_t ns3::RngRsp::GetDlOperBurstProfile ( void ) const

Returns: DlOperBurstProfile: This parameter is sent in response to the RNG-REQ Requested Downlink Burst Profile parameter

Definition at line 372 of file mac-messages.cc.

References m_dlOperBurstProfile.

uint32_t ns3::RngRsp::GetFrameNumber ( void ) const

Definition at line 402 of file mac-messages.cc.

References m_frameNumber.

Referenced by ns3::SSLinkManager::PerformRanging().

Here is the caller graph for this function:

uint8_t ns3::RngRsp::GetInitRangOppNumber ( void ) const

Definition at line 408 of file mac-messages.cc.

References m_initRangOppNumber.

Referenced by ns3::SSLinkManager::PerformRanging().

Here is the caller graph for this function:

TypeId ns3::RngRsp::GetInstanceTypeId ( void ) const

virtual

Returns: the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 433 of file mac-messages.cc.

References GetTypeId().

Here is the call graph for this function:

Mac48Address ns3::RngRsp::GetMacAddress ( void ) const

Definition at line 378 of file mac-messages.cc.

References m_macAddress.

Referenced by ns3::SSLinkManager::PerformRanging().

Here is the caller graph for this function:

std::string ns3::RngRsp::GetName ( void ) const

Definition at line 420 of file mac-messages.cc.

uint32_t ns3::RngRsp::GetOffsetFreqAdjust ( void ) const

Returns: the relative change in transmission frequency that the SS should take in order to better match the BS. This is fine-frequency adjustment within a channel, not reassignment to a different channel.

Definition at line 348 of file mac-messages.cc.

References m_offsetFreqAdjust.

Referenced by ns3::SSLinkManager::AdjustRangingParameters().

Here is the caller graph for this function:

uint8_t ns3::RngRsp::GetPowerLevelAdjust ( void ) const

Returns: the relative change in transmission power level that the SS should take in order that transmissions arrive at the BS at the desired power. When subchannelization is employed, the subscriber shall interpret the power offset adjustment as a required change to the transmitted power density.

Definition at line 342 of file mac-messages.cc.

References m_powerLevelAdjust.

Referenced by ns3::SSLinkManager::AdjustRangingParameters().

Here is the caller graph for this function:

Cid ns3::RngRsp::GetPrimaryCid ( void ) const

Definition at line 390 of file mac-messages.cc.

References m_primaryCid.

Referenced by ns3::SSLinkManager::PerformRanging().

Here is the caller graph for this function:

uint8_t ns3::RngRsp::GetRangStatus ( void ) const

Definition at line 354 of file mac-messages.cc.

References m_rangStatus.

Referenced by ns3::SSLinkManager::PerformRanging(), and ns3::BSLinkManager::ScheduleRngRspMessage().

Here is the caller graph for this function:

uint8_t ns3::RngRsp::GetRangSubchnl ( void ) const

Definition at line 414 of file mac-messages.cc.

References m_rangSubchnl.

uint32_t ns3::RngRsp::GetSerializedSize ( void ) const

virtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 452 of file mac-messages.cc.

uint32_t ns3::RngRsp::GetTimingAdjust ( void ) const

Returns: Tx timing offset adjustment (signed 32-bit). The time required to advance SS transmission so frames arrive at the expected time instance at the BS.

Definition at line 336 of file mac-messages.cc.

References m_timingAdjust.

Referenced by ns3::SSLinkManager::AdjustRangingParameters().

Here is the caller graph for this function:

TypeId ns3::RngRsp::GetTypeId ( void )

static

Definition at line 426 of file mac-messages.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t ns3::RngRsp::GetUlChnlIdOverride ( void ) const

Returns: The identifier of the uplink channel with which the SS is to redo initial ranging

Definition at line 366 of file mac-messages.cc.

References m_ulChnlIdOverride.

void ns3::RngRsp::Print ( std::ostream & os ) const

virtual

Parameters

os output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 439 of file mac-messages.cc.

References m_aasBdcastPermission, m_basicCid, m_dlFreqOverride, m_dlOperBurstProfile, m_frameNumber, m_initRangOppNumber, m_macAddress, m_offsetFreqAdjust, m_powerLevelAdjust, m_primaryCid, m_rangStatus, m_rangSubchnl, m_timingAdjust, and m_ulChnlIdOverride.

void ns3::RngRsp::Serialize ( Buffer::Iterator start ) const

virtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 458 of file mac-messages.cc.

References ns3::Cid::GetIdentifier(), m_aasBdcastPermission, m_basicCid, m_dlFreqOverride, m_dlOperBurstProfile, m_frameNumber, m_initRangOppNumber, m_macAddress, m_offsetFreqAdjust, m_powerLevelAdjust, m_primaryCid, m_rangStatus, m_rangSubchnl, m_reserved, m_timingAdjust, m_ulChnlIdOverride, visualizer.core::start(), ns3::WriteTo(), ns3::Buffer::Iterator::WriteU16(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

void ns3::RngRsp::SetAasBdcastPermission ( uint8_t aasBdcastPermission )

Definition at line 312 of file mac-messages.cc.

References m_aasBdcastPermission.

void ns3::RngRsp::SetBasicCid ( Cid basicCid )

Definition at line 300 of file mac-messages.cc.

References m_basicCid.

Referenced by ns3::ConnectionManager::AllocateManagementConnections().

Here is the caller graph for this function:

void ns3::RngRsp::SetDlFreqOverride ( uint32_t dlFreqOverride )

set the Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging.

Parameters

dlFreqOverride the Center frequency in kHz

Definition at line 276 of file mac-messages.cc.

References m_dlFreqOverride.

Referenced by ns3::BSLinkManager::PerformInitialRanging().

Here is the caller graph for this function:

void ns3::RngRsp::SetDlOperBurstProfile ( uint16_t dlOperBurstProfile )

Definition at line 288 of file mac-messages.cc.

References m_dlOperBurstProfile.

Referenced by ns3::BSLinkManager::PerformInitialRanging().

Here is the caller graph for this function:

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

Definition at line 318 of file mac-messages.cc.

References m_frameNumber.

Referenced by ns3::BSLinkManager::PerformRanging().

Here is the caller graph for this function:

void ns3::RngRsp::SetInitRangOppNumber ( uint8_t initRangOppNumber )

Definition at line 324 of file mac-messages.cc.

References m_initRangOppNumber.

Referenced by ns3::BSLinkManager::PerformRanging().

Here is the caller graph for this function:

void ns3::RngRsp::SetMacAddress ( Mac48Address macAddress )

Definition at line 294 of file mac-messages.cc.

References m_macAddress.

Referenced by ns3::BSLinkManager::PerformInitialRanging().

Here is the caller graph for this function:

void ns3::RngRsp::SetOffsetFreqAdjust ( uint32_t offsetFreqAdjust )

set the relative change in transmission frequency that the SS should take in order to better match the BS.

This is fine-frequency adjustment within a channel, not reassignment to a different channel

Parameters

offsetFreqAdjust

Definition at line 264 of file mac-messages.cc.

References m_offsetFreqAdjust.

Referenced by ns3::BSLinkManager::SetParametersToAdjust().

Here is the caller graph for this function:

void ns3::RngRsp::SetPowerLevelAdjust ( uint8_t powerLevelAdjust )

set the relative change in transmission power level that the SS should make in order that transmissions arrive at the BS at the desired power.

When subchannelization is employed, the subscriber shall interpret the power offset adjustment as a required change to the transmitted power density.

Parameters

powerLevelAdjust the relative change in transmission power level

Definition at line 258 of file mac-messages.cc.

References m_powerLevelAdjust.

Referenced by ns3::BSLinkManager::SetParametersToAdjust().

Here is the caller graph for this function:

void ns3::RngRsp::SetPrimaryCid ( Cid primaryCid )

Definition at line 306 of file mac-messages.cc.

References m_primaryCid.

Referenced by ns3::ConnectionManager::AllocateManagementConnections().

Here is the caller graph for this function:

void ns3::RngRsp::SetRangStatus ( uint8_t rangStatus )

Definition at line 270 of file mac-messages.cc.

References m_rangStatus.

Referenced by ns3::BSLinkManager::AbortRanging(), ns3::BSLinkManager::AcceptRanging(), ns3::BSLinkManager::ContinueRanging(), and ns3::BSLinkManager::PerformRanging().

Here is the caller graph for this function:

void ns3::RngRsp::SetRangSubchnl ( uint8_t rangSubchnl )

Definition at line 330 of file mac-messages.cc.

References m_rangSubchnl.

void ns3::RngRsp::SetTimingAdjust ( uint32_t timingAdjust )

set the Tx timing offset adjustment (signed 32-bit).

Parameters

timingAdjust The time required to advance SS transmission so frames arrive at the expected time instance at the BS.

Definition at line 252 of file mac-messages.cc.

References m_timingAdjust.

Referenced by ns3::BSLinkManager::SetParametersToAdjust().

Here is the caller graph for this function:

void ns3::RngRsp::SetUlChnlIdOverride ( uint8_t ulChnlIdOverride )

set the identifier of the uplink channel with which the SS is to redo initial ranging

Parameters

ulChnlIdOverride the uplink channel index

Definition at line 282 of file mac-messages.cc.

References m_ulChnlIdOverride.

Member Data Documentation

uint8_t ns3::RngRsp::m_aasBdcastPermission

private

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

Referenced by Deserialize(), GetAasBdcastPermission(), Print(), Serialize(), and SetAasBdcastPermission().

Cid ns3::RngRsp::m_basicCid

private

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

Referenced by Deserialize(), GetBasicCid(), Print(), Serialize(), and SetBasicCid().

uint32_t ns3::RngRsp::m_dlFreqOverride

private

Definition at line 216 of file mac-messages.h.

Referenced by Deserialize(), GetDlFreqOverride(), Print(), Serialize(), and SetDlFreqOverride().

uint16_t ns3::RngRsp::m_dlOperBurstProfile

private

Definition at line 225 of file mac-messages.h.

Referenced by Deserialize(), GetDlOperBurstProfile(), Print(), Serialize(), and SetDlOperBurstProfile().

uint32_t ns3::RngRsp::m_frameNumber

private

Definition at line 234 of file mac-messages.h.

Referenced by Deserialize(), GetFrameNumber(), Print(), Serialize(), and SetFrameNumber().

uint8_t ns3::RngRsp::m_initRangOppNumber

private

Definition at line 238 of file mac-messages.h.

Referenced by Deserialize(), GetInitRangOppNumber(), Print(), Serialize(), and SetInitRangOppNumber().

Mac48Address ns3::RngRsp::m_macAddress

private

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

Referenced by Deserialize(), GetMacAddress(), Print(), Serialize(), and SetMacAddress().

uint32_t ns3::RngRsp::m_offsetFreqAdjust

private

Definition at line 212 of file mac-messages.h.

Referenced by Deserialize(), GetOffsetFreqAdjust(), Print(), Serialize(), and SetOffsetFreqAdjust().

uint8_t ns3::RngRsp::m_powerLevelAdjust

private

Definition at line 208 of file mac-messages.h.

Referenced by Deserialize(), GetPowerLevelAdjust(), Print(), Serialize(), and SetPowerLevelAdjust().

Cid ns3::RngRsp::m_primaryCid

private

Definition at line 229 of file mac-messages.h.

Referenced by Deserialize(), GetPrimaryCid(), Print(), Serialize(), and SetPrimaryCid().

uint8_t ns3::RngRsp::m_rangStatus

private

Definition at line 213 of file mac-messages.h.

Referenced by Deserialize(), GetRangStatus(), Print(), Serialize(), and SetRangStatus().

uint8_t ns3::RngRsp::m_rangSubchnl

private

Definition at line 242 of file mac-messages.h.

Referenced by Deserialize(), GetRangSubchnl(), Print(), Serialize(), and SetRangSubchnl().

uint8_t ns3::RngRsp::m_reserved

private

Definition at line 196 of file mac-messages.h.

Referenced by Deserialize(), and Serialize().

uint32_t ns3::RngRsp::m_timingAdjust

private

Definition at line 202 of file mac-messages.h.

Referenced by Deserialize(), GetTimingAdjust(), Print(), Serialize(), and SetTimingAdjust().

uint8_t ns3::RngRsp::m_ulChnlIdOverride

private

Definition at line 220 of file mac-messages.h.

Referenced by Deserialize(), GetUlChnlIdOverride(), Print(), Serialize(), and SetUlChnlIdOverride().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation