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::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:

Public Member Functions

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::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 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

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

Member Function Documentation

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 ns3::CRC8Calculate(), ns3::Buffer::Iterator::GetDistanceFrom(), and ns3::Buffer::Iterator::ReadU8().

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.

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(), and ns3::SubscriberStationNetDevice::Enqueue().

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.

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(), and ns3::Buffer::Iterator::WriteU8().

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