A Discrete-Event Network Simulator
API
ns3::RngReq Class Reference

This class implements the ranging request message described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems". More...

#include "mac-messages.h"

+ Inheritance diagram for ns3::RngReq:
+ Collaboration diagram for ns3::RngReq:

Public Member Functions

 RngReq ()
 
 ~RngReq () override
 
uint32_t Deserialize (Buffer::Iterator start) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
Mac48Address GetMacAddress () const
 Get MAC address field. More...
 
std::string GetName () const
 Get name field. More...
 
uint8_t GetRangingAnomalies () const
 Get ranging anomalies field. More...
 
uint8_t GetReqDlBurstProfile () const
 Get request DL burst profile field. More...
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void PrintDebug () const
 Print debug function. More...
 
void Serialize (Buffer::Iterator start) const override
 
void SetMacAddress (Mac48Address macAddress)
 Set MAC address field. More...
 
void SetRangingAnomalies (uint8_t rangingAnomalies)
 Set ranging anomalies field. More...
 
void SetReqDlBurstProfile (uint8_t reqDlBurstProfile)
 Set request DL burst profile field. More...
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

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

Private Attributes

Mac48Address m_macAddress
 MAC address. More...
 
uint8_t m_rangingAnomalies
 ranging anomalies More...
 
uint8_t m_reqDlBurstProfile
 request DL burst profile More...
 
uint8_t m_reserved
 changed as per the amendment 802.16e-2005 More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

This class implements the ranging request message described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems".

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

Constructor & Destructor Documentation

◆ RngReq()

ns3::RngReq::RngReq ( )

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

◆ ~RngReq()

ns3::RngReq::~RngReq ( )
override

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::RngReq::Deserialize ( Buffer::Iterator  start)
overridevirtual
Parameters
startan iterator which points to where the header should read from.
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.

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_macAddress, m_rangingAnomalies, m_reqDlBurstProfile, m_reserved, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU8(), and two-ray-to-three-gpp-ch-calibration::start.

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::RngReq::GetInstanceTypeId ( ) const
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.

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

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetMacAddress()

Mac48Address ns3::RngReq::GetMacAddress ( ) const

Get MAC address field.

Returns
the MAC address

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

References m_macAddress.

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

+ Here is the caller graph for this function:

◆ GetName()

std::string ns3::RngReq::GetName ( ) const

Get name field.

Returns
the name string

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

◆ GetRangingAnomalies()

uint8_t ns3::RngReq::GetRangingAnomalies ( ) const

Get ranging anomalies field.

Returns
the ranging anomalies

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

References m_rangingAnomalies.

◆ GetReqDlBurstProfile()

uint8_t ns3::RngReq::GetReqDlBurstProfile ( ) const

Get request DL burst profile field.

Returns
the request DL burst profile

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

References m_reqDlBurstProfile.

Referenced by ns3::BurstProfileManager::GetModulationTypeForSS(), and ns3::BSLinkManager::PerformInitialRanging().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::RngReq::GetSerializedSize ( ) const
overridevirtual
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 201 of file mac-messages.cc.

◆ GetTypeId()

TypeId ns3::RngReq::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 171 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:

◆ Print()

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

References m_macAddress, m_rangingAnomalies, and m_reqDlBurstProfile.

◆ PrintDebug()

void ns3::RngReq::PrintDebug ( ) const

Print debug function.

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

References m_macAddress, m_rangingAnomalies, m_reqDlBurstProfile, and NS_LOG_DEBUG.

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

+ Here is the caller graph for this function:

◆ Serialize()

void ns3::RngReq::Serialize ( Buffer::Iterator  start) const
overridevirtual
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 207 of file mac-messages.cc.

References m_macAddress, m_rangingAnomalies, m_reqDlBurstProfile, m_reserved, two-ray-to-three-gpp-ch-calibration::start, ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetMacAddress()

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

Set MAC address field.

Parameters
macAddressthe MAC address

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

References m_macAddress.

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

+ Here is the caller graph for this function:

◆ SetRangingAnomalies()

void ns3::RngReq::SetRangingAnomalies ( uint8_t  rangingAnomalies)

Set ranging anomalies field.

Parameters
rangingAnomaliesthe rnaging anomalies

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

References m_rangingAnomalies.

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

+ Here is the caller graph for this function:

◆ SetReqDlBurstProfile()

void ns3::RngReq::SetReqDlBurstProfile ( uint8_t  reqDlBurstProfile)

Set request DL burst profile field.

Parameters
reqDlBurstProfilethe request DL burst profile

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

References m_reqDlBurstProfile.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_macAddress

Mac48Address ns3::RngReq::m_macAddress
private

MAC address.

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

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

◆ m_rangingAnomalies

uint8_t ns3::RngReq::m_rangingAnomalies
private

ranging anomalies

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

Referenced by Deserialize(), GetRangingAnomalies(), Print(), PrintDebug(), Serialize(), and SetRangingAnomalies().

◆ m_reqDlBurstProfile

uint8_t ns3::RngReq::m_reqDlBurstProfile
private

request DL burst profile

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

Referenced by Deserialize(), GetReqDlBurstProfile(), Print(), PrintDebug(), Serialize(), and SetReqDlBurstProfile().

◆ m_reserved

uint8_t ns3::RngReq::m_reserved
private

changed as per the amendment 802.16e-2005

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

Referenced by Deserialize(), and Serialize().


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