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. More...
#include "ul-mac-messages.h"
Public Member Functions | |
UlMap () | |
~UlMap () override | |
void | AddUlMapElement (OfdmUlMapIe ulMapElement) |
Add UL map element. | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint32_t | GetAllocationStartTime () const |
Get allocation start time. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
std::string | GetName () const |
Get name. | |
uint32_t | GetSerializedSize () const override |
uint8_t | GetUcdCount () const |
Get UCD count. | |
std::list< OfdmUlMapIe > | GetUlMapElements () const |
Get UL map elements. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetAllocationStartTime (uint32_t allocationStartTime) |
Set allocation start time. | |
void | SetUcdCount (uint8_t ucdCount) |
Set UCD count. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
uint32_t | Deserialize (Buffer::Iterator start) override=0 |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | GetSerializedSize () const =0 |
void | Print (std::ostream &os) const override=0 |
virtual void | Serialize (Buffer::Iterator start) const =0 |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
virtual void | Print (std::ostream &os) const =0 |
Print the object contents. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
uint32_t | m_allocationStartTime |
allocation start time | |
uint8_t | m_reserved |
changed as per the amendment 802.16e-2005 | |
uint8_t | m_ucdCount |
UCD count. | |
std::list< OfdmUlMapIe > | m_ulMapElements |
UL map elements. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
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 32 bytes (on a 64-bit architecture).
Definition at line 587 of file ul-mac-messages.h.
ns3::UlMap::UlMap | ( | ) |
Definition at line 573 of file ul-mac-messages.cc.
|
override |
Definition at line 580 of file ul-mac-messages.cc.
void ns3::UlMap::AddUlMapElement | ( | OfdmUlMapIe | ulMapElement | ) |
Add UL map element.
ulMapElement | the UL map element |
Definition at line 597 of file ul-mac-messages.cc.
References m_ulMapElements.
Referenced by ns3::BaseStationNetDevice::CreateUlMap(), and Deserialize().
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 676 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(), and ns3::Buffer::Iterator::ReadU8().
uint32_t ns3::UlMap::GetAllocationStartTime | ( | ) | const |
Get allocation start time.
Definition at line 609 of file ul-mac-messages.cc.
References m_allocationStartTime.
Referenced by ns3::SubscriberStationNetDevice::ProcessUlMap().
|
overridevirtual |
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.
Implements ns3::ObjectBase.
Definition at line 635 of file ul-mac-messages.cc.
References GetTypeId().
std::string ns3::UlMap::GetName | ( | ) | const |
|
overridevirtual |
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 649 of file ul-mac-messages.cc.
References m_ulMapElements.
|
static |
Get the type ID.
Definition at line 627 of file ul-mac-messages.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
uint8_t ns3::UlMap::GetUcdCount | ( | ) | const |
Get UCD count.
Definition at line 603 of file ul-mac-messages.cc.
References m_ucdCount.
Referenced by ns3::SubscriberStationNetDevice::ProcessUlMap().
std::list< OfdmUlMapIe > ns3::UlMap::GetUlMapElements | ( | ) | const |
Get UL map elements.
Definition at line 615 of file ul-mac-messages.cc.
References m_ulMapElements.
Referenced by ns3::SubscriberStationNetDevice::ProcessUlMap().
|
overridevirtual |
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 641 of file ul-mac-messages.cc.
References m_allocationStartTime, m_ucdCount, and m_ulMapElements.
|
overridevirtual |
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 662 of file ul-mac-messages.cc.
References m_allocationStartTime, m_reserved, m_ucdCount, m_ulMapElements, ns3::Buffer::Iterator::Write(), ns3::Buffer::Iterator::WriteU32(), and ns3::Buffer::Iterator::WriteU8().
void ns3::UlMap::SetAllocationStartTime | ( | uint32_t | allocationStartTime | ) |
Set allocation start time.
allocationStartTime | the allocation start time |
Definition at line 591 of file ul-mac-messages.cc.
References m_allocationStartTime.
Referenced by ns3::BaseStationNetDevice::CreateUlMap().
void ns3::UlMap::SetUcdCount | ( | uint8_t | ucdCount | ) |
Set UCD count.
ucdCount | the UCD count |
Definition at line 585 of file ul-mac-messages.cc.
References m_ucdCount.
Referenced by ns3::BaseStationNetDevice::CreateUlMap().
|
private |
allocation start time
Definition at line 645 of file ul-mac-messages.h.
Referenced by Deserialize(), GetAllocationStartTime(), Print(), Serialize(), and SetAllocationStartTime().
|
private |
changed as per the amendment 802.16e-2005
Definition at line 642 of file ul-mac-messages.h.
Referenced by Deserialize(), and Serialize().
|
private |
UCD count.
Definition at line 644 of file ul-mac-messages.h.
Referenced by Deserialize(), GetUcdCount(), Print(), Serialize(), and SetUcdCount().
|
private |
UL map elements.
Definition at line 646 of file ul-mac-messages.h.
Referenced by AddUlMapElement(), Deserialize(), GetSerializedSize(), GetUlMapElements(), Print(), and Serialize().