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
	Get the most derived TypeId for this Object. More...

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 ()

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 erros. 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 (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

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)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 24 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::GenericMacHeader::GenericMacHeader ( void )

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

References c_hcs, m_esf, m_hcs, and m_rsv1.

ns3::GenericMacHeader::~GenericMacHeader ( void )

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

Member Function Documentation

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

Definition at line 300 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

start an 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 263 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 175 of file wimax-mac-header.cc.

References m_ci.

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

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

References m_cid.

Referenced by ns3::BSSchedulerRtps::BSSchedulerBasicConnection(), ns3::BSSchedulerRtps::BSSchedulerBEConnection(), ns3::BSSchedulerRtps::BSSchedulerBroadcastConnection(), ns3::BSSchedulerRtps::BSSchedulerInitialRangingConnection(), ns3::BSSchedulerRtps::BSSchedulerNRTPSConnection(), ns3::BSSchedulerRtps::BSSchedulerPrimaryConnection(), ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), ns3::BaseStationNetDevice::DoReceive(), and ns3::SubscriberStationNetDevice::DoReceive().

Here is the caller graph for this function:

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

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

References m_ec.

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

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

References m_eks.

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

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

References m_hcs.

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

Definition at line 160 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

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 215 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 185 of file wimax-mac-header.cc.

References m_len.

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

Definition at line 200 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 227 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

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

References m_type.

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

Here is the caller graph for this function:

TypeId ns3::GenericMacHeader::GetTypeId ( void )

static

Definition at line 205 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

os output 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 220 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

start an 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 232 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().