A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::RngRsp Class Reference

#include <introspected-doxygen.h>

+ Inheritance 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.
 
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. This is fine-frequency adjustment within a channel, not reassignment to a different channel 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. When subchannelization is employed, the subscriber shall interpret the power offset adjustment as a required change to the transmitted power density. 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::ObjectBase
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)
 

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)
 

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.

Member Function Documentation

uint32_t ns3::RngRsp::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 476 of file mac-messages.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU32(), and ns3::Buffer::Iterator::ReadU8().

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 357 of file mac-messages.cc.

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 369 of file mac-messages.cc.

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 430 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 345 of file mac-messages.cc.

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 339 of file mac-messages.cc.

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 449 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 333 of file mac-messages.cc.

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 363 of file mac-messages.cc.

void ns3::RngRsp::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 436 of file mac-messages.cc.

void ns3::RngRsp::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 455 of file mac-messages.cc.

References ns3::Cid::GetIdentifier(), ns3::Buffer::Iterator::WriteU16(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

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
dlFreqOverridethe Center frequency in kHz

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

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 261 of file mac-messages.cc.

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
powerLevelAdjustthe relative change in transmission power level

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

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

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

Parameters
timingAdjustThe time required to advance SS transmission so frames arrive at the expected time instance at the BS.

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

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

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

Parameters
ulChnlIdOverridethe uplink channel index

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

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