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

this class implements the Generic 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.1 Generic MAC header, page 36 More...

#include <wimax-mac-header.h>

+ Inheritance diagram for ns3::GenericMacHeader:
+ Collaboration diagram for ns3::GenericMacHeader:

Public Member Functions

 GenericMacHeader (void)
 ~GenericMacHeader (void)
bool check_hcs (void) const
uint32_t Deserialize (Buffer::Iterator start)
uint8_t GetCi (void) const
Cid GetCid (void) const
uint8_t GetEc (void) const
uint8_t GetEks (void) const
uint8_t GetHcs (void) const
uint8_t GetHt (void) const
virtual TypeId GetInstanceTypeId (void) const
uint16_t GetLen (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 SetCi (uint8_t ci)
void SetCid (Cid cid)
void SetEc (uint8_t ec)
void SetEks (uint8_t eks)
void SetHcs (uint8_t hcs)
void SetHt (uint8_t HT)
void SetLen (uint16_t len)
void SetType (uint8_t type)
- 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::GenericMacHeader.

Private Attributes

uint8_t c_hcs
uint8_t m_ci
Cid m_cid
uint8_t m_ec
uint8_t m_eks
uint8_t m_esf
uint8_t m_hcs
uint8_t m_ht
uint16_t m_len
uint8_t m_rsv1
uint8_t m_type

Additional Inherited Members

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

Detailed Description

this class implements the Generic 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.1 Generic MAC header, page 36

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

Constructor & Destructor Documentation

ns3::GenericMacHeader::GenericMacHeader ( void  )

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

References c_hcs, m_esf, m_hcs, and m_rsv1.

ns3::GenericMacHeader::~GenericMacHeader ( void  )

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

Member Function Documentation

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

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

References c_hcs, and m_hcs.

Referenced by ns3::BaseStationNetDevice::DoReceive(), and ns3::SubscriberStationNetDevice::DoReceive().

+ Here is the caller graph for this function:

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

References c_hcs, ns3::CRC8Calculate(), ns3::Buffer::Iterator::GetDistanceFrom(), m_ci, m_cid, m_ec, m_eks, m_esf, m_hcs, m_ht, m_len, m_rsv1, m_type, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

uint8_t ns3::GenericMacHeader::GetCi ( void  ) const

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

References m_ci.

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

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

References m_ec.

uint8_t ns3::GenericMacHeader::GetEks ( void  ) const

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

References m_eks.

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

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

References m_hcs.

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

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

References m_ht.

Referenced by ns3::BaseStationNetDevice::DoReceive(), and ns3::SubscriberStationNetDevice::DoReceive().

+ Here is the caller graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

uint16_t ns3::GenericMacHeader::GetLen ( void  ) const

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

References m_len.

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

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

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

Referenced by ns3::WimaxMacQueue::Dequeue(), Ns3WimaxFragmentationTestCase::DoRun(), ns3::BaseStationNetDevice::Enqueue(), ns3::SubscriberStationNetDevice::Enqueue(), and ns3::WimaxMacQueue::GetFirstPacketHdrSize().

+ Here is the caller graph for this function:

uint8_t ns3::GenericMacHeader::GetType ( void  ) const
TypeId ns3::GenericMacHeader::GetTypeId ( void  )
static

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

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

Reimplemented from ns3::Header.

Definition at line 201 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::GenericMacHeader::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 212 of file wimax-mac-header.cc.

References m_ci, m_cid, m_ec, m_eks, m_hcs, m_len, and m_type.

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

References ns3::CRC8Calculate(), ns3::Cid::GetIdentifier(), m_ci, m_cid, m_ec, m_eks, m_esf, m_ht, m_len, m_rsv1, m_type, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::GenericMacHeader::SetCi ( uint8_t  ci)

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

References m_ci.

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

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

References m_cid.

Referenced by Ns3WimaxFragmentationTestCase::DoRun(), ns3::BaseStationNetDevice::Enqueue(), and ns3::SubscriberStationNetDevice::Enqueue().

+ Here is the caller graph for this function:

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

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

References m_ec.

void ns3::GenericMacHeader::SetEks ( uint8_t  eks)

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

References m_eks.

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

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

References m_hcs.

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

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

References m_ht.

void ns3::GenericMacHeader::SetLen ( uint16_t  len)
void ns3::GenericMacHeader::SetType ( uint8_t  type)

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

References m_type.

Referenced by ns3::WimaxMacQueue::Dequeue().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::GenericMacHeader::c_hcs
private

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

Referenced by check_hcs(), Deserialize(), and GenericMacHeader().

uint8_t ns3::GenericMacHeader::m_ci
private

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

Referenced by Deserialize(), GetCi(), Print(), Serialize(), and SetCi().

Cid ns3::GenericMacHeader::m_cid
private

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

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

uint8_t ns3::GenericMacHeader::m_ec
private

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

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

uint8_t ns3::GenericMacHeader::m_eks
private

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

Referenced by Deserialize(), GetEks(), Print(), Serialize(), and SetEks().

uint8_t ns3::GenericMacHeader::m_esf
private

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

Referenced by Deserialize(), GenericMacHeader(), and Serialize().

uint8_t ns3::GenericMacHeader::m_hcs
private

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

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

uint8_t ns3::GenericMacHeader::m_ht
private

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

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

uint16_t ns3::GenericMacHeader::m_len
private

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

Referenced by Deserialize(), GetLen(), Print(), Serialize(), and SetLen().

uint8_t ns3::GenericMacHeader::m_rsv1
private

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

Referenced by Deserialize(), GenericMacHeader(), and Serialize().

uint8_t ns3::GenericMacHeader::m_type
private

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