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

#include <ul-mac-messages.h>

+ Inheritance diagram for ns3::UlMap:
+ Collaboration diagram for ns3::UlMap:

Public Member Functions

 UlMap (void)
 This class implements the UL-MAP_IE message as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 8.2.1.8.2 Compressed UL-MAP, page 404.
virtual ~UlMap (void)
void AddUlMapElement (OfdmUlMapIe ulMapElement)
uint32_t Deserialize (Buffer::Iterator start)
uint32_t GetAllocationStartTime (void) const
virtual TypeId GetInstanceTypeId (void) const
std::string GetName (void) const
uint32_t GetSerializedSize (void) const
uint8_t GetUcdCount (void) const
std::list< OfdmUlMapIeGetUlMapElements (void) const
void Print (std::ostream &os) const
void Serialize (Buffer::Iterator start) const
void SetAllocationStartTime (uint32_t allocationStartTime)
void SetUcdCount (uint8_t ucdCount)
- 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::UlMap.

Private Attributes

uint32_t m_allocationStartTime
uint8_t m_reserved
uint8_t m_ucdCount
std::list< OfdmUlMapIem_ulMapElements

Additional Inherited Members

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

Detailed Description

Definition at line 315 of file ul-mac-messages.h.

Constructor & Destructor Documentation

ns3::UlMap::UlMap ( void  )

This class implements the UL-MAP_IE message as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 8.2.1.8.2 Compressed UL-MAP, page 404.

Definition at line 582 of file ul-mac-messages.cc.

ns3::UlMap::~UlMap ( void  )
virtual

Definition at line 589 of file ul-mac-messages.cc.

Member Function Documentation

void ns3::UlMap::AddUlMapElement ( OfdmUlMapIe  ulMapElement)

Definition at line 606 of file ul-mac-messages.cc.

References m_ulMapElements.

Referenced by ns3::BaseStationNetDevice::CreateUlMap(), and Deserialize().

+ Here is the caller graph for this function:

uint32_t ns3::UlMap::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 690 of file ul-mac-messages.cc.

References AddUlMapElement(), ns3::Buffer::Iterator::GetDistanceFrom(), ns3::OfdmUlMapIe::GetUiuc(), m_allocationStartTime, m_reserved, m_ucdCount, m_ulMapElements, ns3::OfdmUlMapIe::Read(), ns3::Buffer::Iterator::ReadU32(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

uint32_t ns3::UlMap::GetAllocationStartTime ( void  ) const

Definition at line 618 of file ul-mac-messages.cc.

References m_allocationStartTime.

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

+ Here is the caller graph for this function:

TypeId ns3::UlMap::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 646 of file ul-mac-messages.cc.

References GetTypeId().

+ Here is the call graph for this function:

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

Definition at line 630 of file ul-mac-messages.cc.

uint32_t ns3::UlMap::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 660 of file ul-mac-messages.cc.

References ns3::OfdmUlMapIe::GetSize(), and m_ulMapElements.

+ Here is the call graph for this function:

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

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

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

Reimplemented from ns3::Header.

Definition at line 636 of file ul-mac-messages.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint8_t ns3::UlMap::GetUcdCount ( void  ) const

Definition at line 612 of file ul-mac-messages.cc.

References m_ucdCount.

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

+ Here is the caller graph for this function:

std::list< OfdmUlMapIe > ns3::UlMap::GetUlMapElements ( void  ) const

Definition at line 624 of file ul-mac-messages.cc.

References m_ulMapElements.

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

+ Here is the caller graph for this function:

void ns3::UlMap::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 652 of file ul-mac-messages.cc.

References m_allocationStartTime, m_ucdCount, and m_ulMapElements.

void ns3::UlMap::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 674 of file ul-mac-messages.cc.

References m_allocationStartTime, m_reserved, m_ucdCount, m_ulMapElements, visualizer.core::start(), ns3::OfdmUlMapIe::Write(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::UlMap::SetAllocationStartTime ( uint32_t  allocationStartTime)

Definition at line 600 of file ul-mac-messages.cc.

References m_allocationStartTime.

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

+ Here is the caller graph for this function:

void ns3::UlMap::SetUcdCount ( uint8_t  ucdCount)

Definition at line 594 of file ul-mac-messages.cc.

References m_ucdCount.

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

+ Here is the caller graph for this function:

Member Data Documentation

uint32_t ns3::UlMap::m_allocationStartTime
private
uint8_t ns3::UlMap::m_reserved
private

Definition at line 343 of file ul-mac-messages.h.

Referenced by Deserialize(), and Serialize().

uint8_t ns3::UlMap::m_ucdCount
private

Definition at line 345 of file ul-mac-messages.h.

Referenced by Deserialize(), GetUcdCount(), Print(), Serialize(), and SetUcdCount().

std::list<OfdmUlMapIe> ns3::UlMap::m_ulMapElements
private

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