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...
#include "mac-messages.h"
Public Member Functions | |
RngRsp () | |
~RngRsp () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint8_t | GetAasBdcastPermission () const |
Cid | GetBasicCid () const |
uint32_t | GetDlFreqOverride () const |
uint16_t | GetDlOperBurstProfile () const |
uint32_t | GetFrameNumber () const |
uint8_t | GetInitRangOppNumber () const |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
Mac48Address | GetMacAddress () const |
std::string | GetName () const |
uint32_t | GetOffsetFreqAdjust () const |
uint8_t | GetPowerLevelAdjust () const |
Cid | GetPrimaryCid () const |
uint8_t | GetRangStatus () const |
uint8_t | GetRangSubchnl () const |
uint32_t | GetSerializedSize () const override |
uint32_t | GetTimingAdjust () const |
uint8_t | GetUlChnlIdOverride () const |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetAasBdcastPermission (uint8_t aasBdcastPermission) |
set AAS broadcast permission. | |
void | SetBasicCid (Cid basicCid) |
set basic CID. | |
void | SetDlFreqOverride (uint32_t dlFreqOverride) |
set the Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging. | |
void | SetDlOperBurstProfile (uint16_t dlOperBurstProfile) |
set the DL oper burst profile | |
void | SetFrameNumber (uint32_t frameNumber) |
set frame number. | |
void | SetInitRangOppNumber (uint8_t initRangOppNumber) |
set initial range opp number. | |
void | SetMacAddress (Mac48Address macAddress) |
set the MAC address | |
void | SetOffsetFreqAdjust (uint32_t offsetFreqAdjust) |
set the relative change in transmission frequency that the SS should take in order to better match the BS. | |
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. | |
void | SetPrimaryCid (Cid primaryCid) |
set primary CID. | |
void | SetRangStatus (uint8_t rangStatus) |
set the range status. | |
void | SetRangSubchnl (uint8_t rangSubchnl) |
set range sub channel. | |
void | SetTimingAdjust (uint32_t timingAdjust) |
set the Tx timing offset adjustment (signed 32-bit). | |
void | SetUlChnlIdOverride (uint8_t ulChnlIdOverride) |
set the identifier of the uplink channel with which the SS is to redo initial ranging | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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. | |
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 () |
Register this type. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
uint8_t | m_aasBdcastPermission |
AAS broadcast permission. | |
Cid | m_basicCid |
basic CID | |
uint32_t | m_dlFreqOverride |
Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging. | |
uint16_t | m_dlOperBurstProfile |
This parameter is sent in response to the RNG-REQ Requested Downlink Burst Profile parameter. | |
uint32_t | m_frameNumber |
Frame number where the associated RNG_REQ message was detected by the BS. | |
uint8_t | m_initRangOppNumber |
Initial Ranging opportunity (1–255) in which the associated RNG_REQ message was detected by the BS. | |
Mac48Address | m_macAddress |
MAC address. | |
uint32_t | m_offsetFreqAdjust |
Specifies the relative change in transmission frequency that the SS is to make in order to better match the BS. | |
uint8_t | m_powerLevelAdjust |
Specifies the relative change in transmission power level that the SS is to make in order that transmissions arrive at the BS at the desired power. | |
Cid | m_primaryCid |
primary CID | |
uint8_t | m_rangStatus |
range status. | |
uint8_t | m_rangSubchnl |
Used to indicate the OFDM subchannel reference that was used to transmit the initial ranging message (OFDM with subchannelization). | |
uint8_t | m_reserved |
changed as per the amendment 802.16e-2005 | |
uint32_t | m_timingAdjust |
Tx timing offset adjustment (signed 32-bit). | |
uint8_t | m_ulChnlIdOverride |
Licensed bands: The identifier of the uplink channel with which the SS is to redo initial ranging (not used with PHYs without channelized uplinks). | |
Additional Inherited Members | |
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. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wimax
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 113 of file mac-messages.h.
ns3::RngRsp::RngRsp | ( | ) |
Definition at line 221 of file mac-messages.cc.
|
override |
Definition at line 240 of file mac-messages.cc.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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.
Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.
Implements ns3::Header.
Definition at line 478 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(), and ns3::Buffer::Iterator::ReadU8().
uint8_t ns3::RngRsp::GetAasBdcastPermission | ( | ) | const |
Definition at line 389 of file mac-messages.cc.
References m_aasBdcastPermission.
Cid ns3::RngRsp::GetBasicCid | ( | ) | const |
Definition at line 377 of file mac-messages.cc.
References m_basicCid.
Referenced by ns3::SSLinkManager::PerformRanging().
uint32_t ns3::RngRsp::GetDlFreqOverride | ( | ) | const |
Definition at line 353 of file mac-messages.cc.
References m_dlFreqOverride.
Referenced by ns3::SSLinkManager::PerformRanging().
uint16_t ns3::RngRsp::GetDlOperBurstProfile | ( | ) | const |
Definition at line 365 of file mac-messages.cc.
References m_dlOperBurstProfile.
uint32_t ns3::RngRsp::GetFrameNumber | ( | ) | const |
Definition at line 395 of file mac-messages.cc.
References m_frameNumber.
Referenced by ns3::SSLinkManager::PerformRanging().
uint8_t ns3::RngRsp::GetInitRangOppNumber | ( | ) | const |
Definition at line 401 of file mac-messages.cc.
References m_initRangOppNumber.
Referenced by ns3::SSLinkManager::PerformRanging().
|
overridevirtual |
Get the most derived TypeId for this Object.
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 427 of file mac-messages.cc.
References GetTypeId().
Mac48Address ns3::RngRsp::GetMacAddress | ( | ) | const |
Definition at line 371 of file mac-messages.cc.
References m_macAddress.
Referenced by ns3::SSLinkManager::PerformRanging().
std::string ns3::RngRsp::GetName | ( | ) | const |
Definition at line 413 of file mac-messages.cc.
uint32_t ns3::RngRsp::GetOffsetFreqAdjust | ( | ) | const |
Definition at line 341 of file mac-messages.cc.
References m_offsetFreqAdjust.
Referenced by ns3::SSLinkManager::AdjustRangingParameters().
uint8_t ns3::RngRsp::GetPowerLevelAdjust | ( | ) | const |
Definition at line 335 of file mac-messages.cc.
References m_powerLevelAdjust.
Referenced by ns3::SSLinkManager::AdjustRangingParameters().
Cid ns3::RngRsp::GetPrimaryCid | ( | ) | const |
Definition at line 383 of file mac-messages.cc.
References m_primaryCid.
Referenced by ns3::SSLinkManager::PerformRanging().
uint8_t ns3::RngRsp::GetRangStatus | ( | ) | const |
Definition at line 347 of file mac-messages.cc.
References m_rangStatus.
Referenced by ns3::SSLinkManager::PerformRanging(), and ns3::BSLinkManager::ScheduleRngRspMessage().
uint8_t ns3::RngRsp::GetRangSubchnl | ( | ) | const |
|
overridevirtual |
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 451 of file mac-messages.cc.
uint32_t ns3::RngRsp::GetTimingAdjust | ( | ) | const |
Definition at line 329 of file mac-messages.cc.
References m_timingAdjust.
Referenced by ns3::SSLinkManager::AdjustRangingParameters().
|
static |
Register this type.
Definition at line 419 of file mac-messages.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
uint8_t ns3::RngRsp::GetUlChnlIdOverride | ( | ) | const |
Definition at line 359 of file mac-messages.cc.
References m_ulChnlIdOverride.
|
overridevirtual |
os | output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header 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 433 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.
|
overridevirtual |
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 457 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, ns3::WriteTo(), ns3::Buffer::Iterator::WriteU16(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().
void ns3::RngRsp::SetAasBdcastPermission | ( | uint8_t | aasBdcastPermission | ) |
set AAS broadcast permission.
aasBdcastPermission | AAS broadcast permission |
Definition at line 305 of file mac-messages.cc.
References m_aasBdcastPermission.
void ns3::RngRsp::SetBasicCid | ( | Cid | basicCid | ) |
set basic CID.
basicCid | Basic CID |
Definition at line 293 of file mac-messages.cc.
References m_basicCid.
Referenced by ns3::ConnectionManager::AllocateManagementConnections().
void ns3::RngRsp::SetDlFreqOverride | ( | uint32_t | dlFreqOverride | ) |
set the Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging.
dlFreqOverride | the Center frequency in kHz |
Definition at line 269 of file mac-messages.cc.
References m_dlFreqOverride.
Referenced by ns3::BSLinkManager::PerformInitialRanging().
void ns3::RngRsp::SetDlOperBurstProfile | ( | uint16_t | dlOperBurstProfile | ) |
set the DL oper burst profile
dlOperBurstProfile | the oper burt profile |
Definition at line 281 of file mac-messages.cc.
References m_dlOperBurstProfile.
Referenced by ns3::BSLinkManager::PerformInitialRanging().
void ns3::RngRsp::SetFrameNumber | ( | uint32_t | frameNumber | ) |
set frame number.
frameNumber | Frame number |
Definition at line 311 of file mac-messages.cc.
References m_frameNumber.
Referenced by ns3::BSLinkManager::PerformRanging().
void ns3::RngRsp::SetInitRangOppNumber | ( | uint8_t | initRangOppNumber | ) |
set initial range opp number.
initRangOppNumber | Initial range opp number |
Definition at line 317 of file mac-messages.cc.
References m_initRangOppNumber.
Referenced by ns3::BSLinkManager::PerformRanging().
void ns3::RngRsp::SetMacAddress | ( | Mac48Address | macAddress | ) |
set the MAC address
macAddress | the MAC address |
Definition at line 287 of file mac-messages.cc.
References m_macAddress.
Referenced by ns3::BSLinkManager::PerformInitialRanging().
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
offsetFreqAdjust | Offset frequency adjustment |
Definition at line 257 of file mac-messages.cc.
References m_offsetFreqAdjust.
Referenced by ns3::BSLinkManager::SetParametersToAdjust().
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.
powerLevelAdjust | the relative change in transmission power level |
Definition at line 251 of file mac-messages.cc.
References m_powerLevelAdjust.
Referenced by ns3::BSLinkManager::SetParametersToAdjust().
void ns3::RngRsp::SetPrimaryCid | ( | Cid | primaryCid | ) |
set primary CID.
primaryCid | Primary CID |
Definition at line 299 of file mac-messages.cc.
References m_primaryCid.
Referenced by ns3::ConnectionManager::AllocateManagementConnections().
void ns3::RngRsp::SetRangStatus | ( | uint8_t | rangStatus | ) |
set the range status.
rangStatus | Range status |
Definition at line 263 of file mac-messages.cc.
References m_rangStatus.
Referenced by ns3::BSLinkManager::AbortRanging(), ns3::BSLinkManager::AcceptRanging(), ns3::BSLinkManager::ContinueRanging(), and ns3::BSLinkManager::PerformRanging().
void ns3::RngRsp::SetRangSubchnl | ( | uint8_t | rangSubchnl | ) |
set range sub channel.
rangSubchnl | Range subchannel |
Definition at line 323 of file mac-messages.cc.
References m_rangSubchnl.
void ns3::RngRsp::SetTimingAdjust | ( | uint32_t | timingAdjust | ) |
set the Tx timing offset adjustment (signed 32-bit).
timingAdjust | The time required to advance SS transmission so frames arrive at the expected time instance at the BS. |
Definition at line 245 of file mac-messages.cc.
References m_timingAdjust.
Referenced by ns3::BSLinkManager::SetParametersToAdjust().
void ns3::RngRsp::SetUlChnlIdOverride | ( | uint8_t | ulChnlIdOverride | ) |
set the identifier of the uplink channel with which the SS is to redo initial ranging
ulChnlIdOverride | the uplink channel index |
Definition at line 275 of file mac-messages.cc.
References m_ulChnlIdOverride.
|
private |
AAS broadcast permission.
Definition at line 328 of file mac-messages.h.
Referenced by Deserialize(), GetAasBdcastPermission(), Print(), Serialize(), and SetAasBdcastPermission().
|
private |
basic CID
Definition at line 326 of file mac-messages.h.
Referenced by Deserialize(), GetBasicCid(), Print(), Serialize(), and SetBasicCid().
|
private |
Center frequency, in kHz, of new downlink channel where the SS should redo initial ranging.
Definition at line 309 of file mac-messages.h.
Referenced by Deserialize(), GetDlFreqOverride(), Print(), Serialize(), and SetDlFreqOverride().
|
private |
This parameter is sent in response to the RNG-REQ Requested Downlink Burst Profile parameter.
Byte 0: Specifies the least robust DIUC that may be used by the BS for transmissions to the SS. Byte 1: Configuration Change Count value of DCD defining the burst profile associated with DIUC.
Definition at line 323 of file mac-messages.h.
Referenced by Deserialize(), GetDlOperBurstProfile(), Print(), Serialize(), and SetDlOperBurstProfile().
|
private |
Frame number where the associated RNG_REQ message was detected by the BS.
Usage is mutually exclusive with SS MAC Address
Definition at line 334 of file mac-messages.h.
Referenced by Deserialize(), GetFrameNumber(), Print(), Serialize(), and SetFrameNumber().
|
private |
Initial Ranging opportunity (1–255) in which the associated RNG_REQ message was detected by the BS.
Usage is mutually exclusive with SS MAC Address
Definition at line 340 of file mac-messages.h.
Referenced by Deserialize(), GetInitRangOppNumber(), Print(), Serialize(), and SetInitRangOppNumber().
|
private |
MAC address.
Definition at line 325 of file mac-messages.h.
Referenced by Deserialize(), GetMacAddress(), Print(), Serialize(), and SetMacAddress().
|
private |
Specifies the relative change in transmission frequency that the SS is to make in order to better match the BS.
This is fine-frequency adjustment within a channel, not reassignment to a different channel.
Definition at line 301 of file mac-messages.h.
Referenced by Deserialize(), GetOffsetFreqAdjust(), Print(), Serialize(), and SetOffsetFreqAdjust().
|
private |
Specifies the relative change in transmission power level that the SS is to 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.
Definition at line 294 of file mac-messages.h.
Referenced by Deserialize(), GetPowerLevelAdjust(), Print(), Serialize(), and SetPowerLevelAdjust().
|
private |
primary CID
Definition at line 327 of file mac-messages.h.
Referenced by Deserialize(), GetPrimaryCid(), Print(), Serialize(), and SetPrimaryCid().
|
private |
range status.
Definition at line 306 of file mac-messages.h.
Referenced by Deserialize(), GetRangStatus(), Print(), Serialize(), and SetRangStatus().
|
private |
Used to indicate the OFDM subchannel reference that was used to transmit the initial ranging message (OFDM with subchannelization).
Definition at line 346 of file mac-messages.h.
Referenced by Deserialize(), GetRangSubchnl(), Print(), Serialize(), and SetRangSubchnl().
|
private |
changed as per the amendment 802.16e-2005
Definition at line 278 of file mac-messages.h.
Referenced by Deserialize(), and Serialize().
|
private |
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 286 of file mac-messages.h.
Referenced by Deserialize(), GetTimingAdjust(), Print(), Serialize(), and SetTimingAdjust().
|
private |
Licensed bands: The identifier of the uplink channel with which the SS is to redo initial ranging (not used with PHYs without channelized uplinks).
Definition at line 315 of file mac-messages.h.
Referenced by Deserialize(), GetUlChnlIdOverride(), Print(), Serialize(), and SetUlChnlIdOverride().