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

#include <wimax-mac-header.h>

+ Inheritance diagram for ns3::GrantManagementSubheader:
+ Collaboration diagram for ns3::GrantManagementSubheader:

Public Member Functions

 GrantManagementSubheader (void)
 this class implements the grant management sub-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.2.2 Grant Management subheader, page 40
 ~GrantManagementSubheader (void)
uint32_t Deserialize (Buffer::Iterator start)
virtual TypeId GetInstanceTypeId (void) const
std::string GetName (void) const
uint16_t GetPbr (void) const
uint8_t GetPm (void) const
uint32_t GetSerializedSize (void) const
uint8_t GetSi (void) const
void Print (std::ostream &os) const
void Serialize (Buffer::Iterator start) const
void SetPbr (uint16_t pbr)
void SetPm (uint8_t pm)
void SetSi (uint8_t si)
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::GrantManagementSubheader.

Private Attributes

uint16_t m_pbr
uint8_t m_pm
uint8_t m_si

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
virtual void NotifyConstructionCompleted (void)

Detailed Description

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

Constructor & Destructor Documentation

ns3::GrantManagementSubheader::GrantManagementSubheader ( void  )

this class implements the grant management sub-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.2.2 Grant Management subheader, page 40

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

ns3::GrantManagementSubheader::~GrantManagementSubheader ( void  )

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

Member Function Documentation

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_pbr, m_pm, m_si, ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

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

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

uint16_t ns3::GrantManagementSubheader::GetPbr ( void  ) const

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

References m_pbr.

uint8_t ns3::GrantManagementSubheader::GetPm ( void  ) const

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

References m_pm.

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

uint8_t ns3::GrantManagementSubheader::GetSi ( void  ) const

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

References m_si.

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

This method returns the TypeId associated to ns3::GrantManagementSubheader.

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

Reimplemented from ns3::Header.

Definition at line 529 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::GrantManagementSubheader::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 541 of file wimax-mac-header.cc.

References m_pbr, m_pm, and m_si.

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

References m_pbr, m_pm, m_si, visualizer.core::start(), ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::GrantManagementSubheader::SetPbr ( uint16_t  pbr)

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

References m_pbr.

void ns3::GrantManagementSubheader::SetPm ( uint8_t  pm)

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

References m_pm.

Referenced by ns3::SubscriberStationNetDevice::Enqueue().

+ Here is the caller graph for this function:

void ns3::GrantManagementSubheader::SetSi ( uint8_t  si)

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

References m_si.

Member Data Documentation

uint16_t ns3::GrantManagementSubheader::m_pbr
private

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

Referenced by Deserialize(), GetPbr(), Print(), Serialize(), and SetPbr().

uint8_t ns3::GrantManagementSubheader::m_pm
private

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

Referenced by Deserialize(), GetPm(), Print(), Serialize(), and SetPm().

uint8_t ns3::GrantManagementSubheader::m_si
private

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

Referenced by Deserialize(), GetSi(), Print(), Serialize(), and SetSi().


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