A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::BandwidthRequestHeader Class Reference

this class implements the bandwidth-request mac Header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.1.2 Bandwidth request header, page 38 More...

#include <wimax-mac-header.h>

+ Inheritance diagram for ns3::BandwidthRequestHeader:
+ Collaboration diagram for ns3::BandwidthRequestHeader:

Public Types

enum  HeaderType { HEADER_TYPE_INCREMENTAL, HEADER_TYPE_AGGREGATE }
 

Public Member Functions

 BandwidthRequestHeader (void)
 
 ~BandwidthRequestHeader (void)
 
bool check_hcs (void) const
 
uint32_t Deserialize (Buffer::Iterator start)
 
uint32_t GetBr (void) const
 
Cid GetCid (void) const
 
uint8_t GetEc (void) const
 
uint8_t GetHcs (void) const
 
uint8_t GetHt (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
std::string GetName (void) const
 
uint32_t GetSerializedSize (void) const
 
uint8_t GetType (void) const
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetBr (uint32_t br)
 
void SetCid (Cid cid)
 
void SetEc (uint8_t ec)
 
void SetHcs (uint8_t hcs)
 
void SetHt (uint8_t HT)
 
void SetType (uint8_t type)
 
- 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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t c_hcs
 
uint32_t m_br
 
Cid m_cid
 
uint8_t m_ec
 
uint8_t m_hcs
 
uint8_t m_ht
 
uint8_t m_type
 

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

this class implements the bandwidth-request mac Header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.1.2 Bandwidth request header, page 38

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 150 of file wimax-mac-header.h.

Member Enumeration Documentation

Enumerator
HEADER_TYPE_INCREMENTAL 
HEADER_TYPE_AGGREGATE 

Definition at line 153 of file wimax-mac-header.h.

Constructor & Destructor Documentation

ns3::BandwidthRequestHeader::BandwidthRequestHeader ( void  )

Definition at line 301 of file wimax-mac-header.cc.

ns3::BandwidthRequestHeader::~BandwidthRequestHeader ( void  )

Definition at line 311 of file wimax-mac-header.cc.

Member Function Documentation

bool ns3::BandwidthRequestHeader::check_hcs ( void  ) const

Definition at line 474 of file wimax-mac-header.cc.

References c_hcs, and m_hcs.

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

+ Here is the caller graph for this function:

uint32_t ns3::BandwidthRequestHeader::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 437 of file wimax-mac-header.cc.

References c_hcs, ns3::CRC8Calculate(), ns3::Buffer::Iterator::GetDistanceFrom(), m_br, m_cid, m_ec, m_hcs, m_ht, m_type, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

uint32_t ns3::BandwidthRequestHeader::GetBr ( void  ) const

Definition at line 360 of file wimax-mac-header.cc.

References m_br.

Referenced by ns3::BandwidthManager::ProcessBandwidthRequest(), and ns3::UplinkSchedulerMBQoS::ProcessBandwidthRequest().

+ Here is the caller graph for this function:

Cid ns3::BandwidthRequestHeader::GetCid ( void  ) const

Definition at line 365 of file wimax-mac-header.cc.

References m_cid.

Referenced by ns3::BaseStationNetDevice::DoReceive(), ns3::BandwidthManager::ProcessBandwidthRequest(), and ns3::UplinkSchedulerMBQoS::ProcessBandwidthRequest().

+ Here is the caller graph for this function:

uint8_t ns3::BandwidthRequestHeader::GetEc ( void  ) const

Definition at line 350 of file wimax-mac-header.cc.

References m_ec.

uint8_t ns3::BandwidthRequestHeader::GetHcs ( void  ) const

Definition at line 370 of file wimax-mac-header.cc.

References m_hcs.

uint8_t ns3::BandwidthRequestHeader::GetHt ( void  ) const

Definition at line 345 of file wimax-mac-header.cc.

References m_ht.

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

+ Here is the caller graph for this function:

TypeId ns3::BandwidthRequestHeader::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 387 of file wimax-mac-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

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

Definition at line 375 of file wimax-mac-header.cc.

uint32_t ns3::BandwidthRequestHeader::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 400 of file wimax-mac-header.cc.

uint8_t ns3::BandwidthRequestHeader::GetType ( void  ) const

Definition at line 355 of file wimax-mac-header.cc.

References m_type.

Referenced by ns3::BandwidthManager::ProcessBandwidthRequest().

+ Here is the caller graph for this function:

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

Definition at line 380 of file wimax-mac-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::BandwidthRequestHeader::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 392 of file wimax-mac-header.cc.

References ns3::Cid::GetIdentifier(), m_br, m_cid, m_ec, m_hcs, and m_type.

+ Here is the call graph for this function:

void ns3::BandwidthRequestHeader::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 408 of file wimax-mac-header.cc.

References ns3::CRC8Calculate(), ns3::Cid::GetIdentifier(), m_br, m_cid, m_ec, m_ht, m_type, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::BandwidthRequestHeader::SetBr ( uint32_t  br)

Definition at line 330 of file wimax-mac-header.cc.

References m_br.

Referenced by ns3::BandwidthManager::SendBandwidthRequest().

+ Here is the caller graph for this function:

void ns3::BandwidthRequestHeader::SetCid ( Cid  cid)

Definition at line 335 of file wimax-mac-header.cc.

References m_cid.

Referenced by ns3::BandwidthManager::SendBandwidthRequest().

+ Here is the caller graph for this function:

void ns3::BandwidthRequestHeader::SetEc ( uint8_t  ec)

Definition at line 320 of file wimax-mac-header.cc.

References m_ec.

void ns3::BandwidthRequestHeader::SetHcs ( uint8_t  hcs)

Definition at line 340 of file wimax-mac-header.cc.

References m_hcs.

void ns3::BandwidthRequestHeader::SetHt ( uint8_t  HT)

Definition at line 315 of file wimax-mac-header.cc.

References m_ht.

void ns3::BandwidthRequestHeader::SetType ( uint8_t  type)

Definition at line 325 of file wimax-mac-header.cc.

References m_type.

Referenced by ns3::BandwidthManager::SendBandwidthRequest().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::BandwidthRequestHeader::c_hcs
private

Definition at line 190 of file wimax-mac-header.h.

Referenced by check_hcs(), and Deserialize().

uint32_t ns3::BandwidthRequestHeader::m_br
private

Definition at line 187 of file wimax-mac-header.h.

Referenced by Deserialize(), GetBr(), Print(), Serialize(), and SetBr().

Cid ns3::BandwidthRequestHeader::m_cid
private

Definition at line 188 of file wimax-mac-header.h.

Referenced by Deserialize(), GetCid(), Print(), Serialize(), and SetCid().

uint8_t ns3::BandwidthRequestHeader::m_ec
private

Definition at line 185 of file wimax-mac-header.h.

Referenced by Deserialize(), GetEc(), Print(), Serialize(), and SetEc().

uint8_t ns3::BandwidthRequestHeader::m_hcs
private

Definition at line 189 of file wimax-mac-header.h.

Referenced by check_hcs(), Deserialize(), GetHcs(), Print(), and SetHcs().

uint8_t ns3::BandwidthRequestHeader::m_ht
private

Definition at line 184 of file wimax-mac-header.h.

Referenced by Deserialize(), GetHt(), Serialize(), and SetHt().

uint8_t ns3::BandwidthRequestHeader::m_type
private

Definition at line 186 of file wimax-mac-header.h.

Referenced by Deserialize(), GetType(), Print(), Serialize(), and SetType().


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