This class implements the UCD message as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.3 Uplink Channel Descriptor (UCD) message, page 47. More...
#include "ul-mac-messages.h"
Public Member Functions | |
Ucd () | |
~Ucd () override | |
void | AddUlBurstProfile (OfdmUlBurstProfile ulBurstProfile) |
Add UL burst profile. | |
uint32_t | Deserialize (Buffer::Iterator start) override |
OfdmUcdChannelEncodings | GetChannelEncodings () const |
Get channel encodings. | |
uint8_t | GetConfigurationChangeCount () const |
Get configuration change count. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
std::string | GetName () const |
Get name. | |
uint8_t | GetNrUlBurstProfiles () const |
Get number UL burst profiles. | |
uint8_t | GetRangingBackoffEnd () const |
Get ranging backoff end. | |
uint8_t | GetRangingBackoffStart () const |
Get ranging backoff start. | |
uint8_t | GetRequestBackoffEnd () const |
Get request backoff end. | |
uint8_t | GetRequestBackoffStart () const |
Get request backoff start. | |
uint32_t | GetSerializedSize () const override |
std::vector< OfdmUlBurstProfile > | GetUlBurstProfiles () const |
Get UL burst profiles. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetChannelEncodings (OfdmUcdChannelEncodings channelEncodings) |
Set channel encodings. | |
void | SetConfigurationChangeCount (uint8_t ucdCount) |
Set configuration change count. | |
void | SetNrUlBurstProfiles (uint8_t nrUlBurstProfiles) |
Set NR UL burst profiles. | |
void | SetRangingBackoffEnd (uint8_t rangingBackoffEnd) |
Set ranging backoff end. | |
void | SetRangingBackoffStart (uint8_t rangingBackoffStart) |
Set ranging backoff start. | |
void | SetRequestBackoffEnd (uint8_t requestBackoffEnd) |
Set request backoff end. | |
void | SetRequestBackoffStart (uint8_t requestBackoffStart) |
Set request backoff start. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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. | |
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 | |
OfdmUcdChannelEncodings | m_channelEncodings |
TLV Encoded information for the overall channel. | |
uint8_t | m_configurationChangeCount |
configuration change count | |
uint8_t | m_nrUlBurstProfiles |
number UL burst profiles | |
uint8_t | m_rangingBackoffEnd |
ranging backoff end | |
uint8_t | m_rangingBackoffStart |
ranging backoff start | |
uint8_t | m_requestBackoffEnd |
request backoff end | |
uint8_t | m_requestBackoffStart |
request backoff start | |
std::vector< OfdmUlBurstProfile > | m_ulBurstProfiles |
UL burst profiles. | |
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 Symbols 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 UCD message as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.3 Uplink Channel Descriptor (UCD) message, page 47.
Definition at line 313 of file ul-mac-messages.h.
ns3::Ucd::Ucd | ( | ) |
Definition at line 245 of file ul-mac-messages.cc.
|
override |
Definition at line 255 of file ul-mac-messages.cc.
void ns3::Ucd::AddUlBurstProfile | ( | OfdmUlBurstProfile | ulBurstProfile | ) |
Add UL burst profile.
ulBurstProfile | the UL burst profile |
Definition at line 296 of file ul-mac-messages.cc.
References m_ulBurstProfiles.
Referenced by Deserialize(), and ns3::BaseStationNetDevice::SetUlBurstProfiles().
|
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 418 of file ul-mac-messages.cc.
References AddUlBurstProfile(), ns3::Buffer::Iterator::GetDistanceFrom(), m_channelEncodings, m_configurationChangeCount, m_nrUlBurstProfiles, m_rangingBackoffEnd, m_rangingBackoffStart, m_requestBackoffEnd, m_requestBackoffStart, ns3::OfdmUlBurstProfile::Read(), ns3::UcdChannelEncodings::Read(), and ns3::Buffer::Iterator::ReadU8().
OfdmUcdChannelEncodings ns3::Ucd::GetChannelEncodings | ( | ) | const |
Get channel encodings.
Definition at line 339 of file ul-mac-messages.cc.
References m_channelEncodings.
Referenced by ns3::SubscriberStationNetDevice::ProcessUcd().
uint8_t ns3::Ucd::GetConfigurationChangeCount | ( | ) | const |
Get configuration change count.
Definition at line 309 of file ul-mac-messages.cc.
References m_configurationChangeCount.
Referenced by ns3::SubscriberStationNetDevice::ProcessUcd().
|
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 371 of file ul-mac-messages.cc.
References GetTypeId().
std::string ns3::Ucd::GetName | ( | ) | const |
uint8_t ns3::Ucd::GetNrUlBurstProfiles | ( | ) | const |
Get number UL burst profiles.
Definition at line 351 of file ul-mac-messages.cc.
References m_nrUlBurstProfiles.
uint8_t ns3::Ucd::GetRangingBackoffEnd | ( | ) | const |
Get ranging backoff end.
Definition at line 321 of file ul-mac-messages.cc.
References m_rangingBackoffEnd.
uint8_t ns3::Ucd::GetRangingBackoffStart | ( | ) | const |
Get ranging backoff start.
Definition at line 315 of file ul-mac-messages.cc.
References m_rangingBackoffStart.
Referenced by ns3::SubscriberStationNetDevice::ProcessUcd().
uint8_t ns3::Ucd::GetRequestBackoffEnd | ( | ) | const |
Get request backoff end.
Definition at line 333 of file ul-mac-messages.cc.
References m_requestBackoffEnd.
uint8_t ns3::Ucd::GetRequestBackoffStart | ( | ) | const |
Get request backoff start.
Definition at line 327 of file ul-mac-messages.cc.
References m_requestBackoffStart.
|
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 388 of file ul-mac-messages.cc.
References ns3::OfdmUcdChannelEncodings::GetSize(), m_channelEncodings, and m_ulBurstProfiles.
|
static |
Get the type ID.
Definition at line 363 of file ul-mac-messages.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
std::vector< OfdmUlBurstProfile > ns3::Ucd::GetUlBurstProfiles | ( | ) | const |
Get UL burst profiles.
Definition at line 345 of file ul-mac-messages.cc.
References m_ulBurstProfiles.
Referenced by ns3::SubscriberStationNetDevice::ProcessUcd().
|
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 377 of file ul-mac-messages.cc.
References m_configurationChangeCount, m_rangingBackoffEnd, m_rangingBackoffStart, m_requestBackoffEnd, m_requestBackoffStart, and m_ulBurstProfiles.
|
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 401 of file ul-mac-messages.cc.
References m_channelEncodings, m_configurationChangeCount, m_rangingBackoffEnd, m_rangingBackoffStart, m_requestBackoffEnd, m_requestBackoffStart, m_ulBurstProfiles, ns3::Buffer::Iterator::Write(), ns3::UcdChannelEncodings::Write(), and ns3::Buffer::Iterator::WriteU8().
void ns3::Ucd::SetChannelEncodings | ( | OfdmUcdChannelEncodings | channelEncodings | ) |
Set channel encodings.
channelEncodings | the channel encodings |
Definition at line 290 of file ul-mac-messages.cc.
References m_channelEncodings.
Referenced by ns3::BaseStationNetDevice::CreateUcd().
void ns3::Ucd::SetConfigurationChangeCount | ( | uint8_t | ucdCount | ) |
Set configuration change count.
ucdCount | the UCD count |
Definition at line 260 of file ul-mac-messages.cc.
References m_configurationChangeCount.
Referenced by ns3::BaseStationNetDevice::CreateUcd().
void ns3::Ucd::SetNrUlBurstProfiles | ( | uint8_t | nrUlBurstProfiles | ) |
Set NR UL burst profiles.
nrUlBurstProfiles | the NR UL burst profiles |
Definition at line 302 of file ul-mac-messages.cc.
References m_nrUlBurstProfiles.
Referenced by ns3::SubscriberStationNetDevice::DoReceive().
void ns3::Ucd::SetRangingBackoffEnd | ( | uint8_t | rangingBackoffEnd | ) |
Set ranging backoff end.
rangingBackoffEnd | the ranging backoff end |
Definition at line 272 of file ul-mac-messages.cc.
References m_rangingBackoffEnd.
Referenced by ns3::BaseStationNetDevice::CreateUcd().
void ns3::Ucd::SetRangingBackoffStart | ( | uint8_t | rangingBackoffStart | ) |
Set ranging backoff start.
rangingBackoffStart | ranging backoff start |
Definition at line 266 of file ul-mac-messages.cc.
References m_rangingBackoffStart.
Referenced by ns3::BaseStationNetDevice::CreateUcd().
void ns3::Ucd::SetRequestBackoffEnd | ( | uint8_t | requestBackoffEnd | ) |
Set request backoff end.
requestBackoffEnd | the request backoff end |
Definition at line 284 of file ul-mac-messages.cc.
References m_requestBackoffEnd.
Referenced by ns3::BaseStationNetDevice::CreateUcd().
void ns3::Ucd::SetRequestBackoffStart | ( | uint8_t | requestBackoffStart | ) |
Set request backoff start.
requestBackoffStart | the request backoff start |
Definition at line 278 of file ul-mac-messages.cc.
References m_requestBackoffStart.
Referenced by ns3::BaseStationNetDevice::CreateUcd().
|
private |
TLV Encoded information for the overall channel.
Definition at line 423 of file ul-mac-messages.h.
Referenced by Deserialize(), GetChannelEncodings(), GetSerializedSize(), Serialize(), and SetChannelEncodings().
|
private |
configuration change count
Definition at line 418 of file ul-mac-messages.h.
Referenced by Deserialize(), GetConfigurationChangeCount(), Print(), Serialize(), and SetConfigurationChangeCount().
|
private |
number UL burst profiles
Definition at line 426 of file ul-mac-messages.h.
Referenced by Deserialize(), GetNrUlBurstProfiles(), and SetNrUlBurstProfiles().
|
private |
ranging backoff end
Definition at line 420 of file ul-mac-messages.h.
Referenced by Deserialize(), GetRangingBackoffEnd(), Print(), Serialize(), and SetRangingBackoffEnd().
|
private |
ranging backoff start
Definition at line 419 of file ul-mac-messages.h.
Referenced by Deserialize(), GetRangingBackoffStart(), Print(), Serialize(), and SetRangingBackoffStart().
|
private |
request backoff end
Definition at line 422 of file ul-mac-messages.h.
Referenced by Deserialize(), GetRequestBackoffEnd(), Print(), Serialize(), and SetRequestBackoffEnd().
|
private |
request backoff start
Definition at line 421 of file ul-mac-messages.h.
Referenced by Deserialize(), GetRequestBackoffStart(), Print(), Serialize(), and SetRequestBackoffStart().
|
private |
UL burst profiles.
Definition at line 424 of file ul-mac-messages.h.
Referenced by AddUlBurstProfile(), GetSerializedSize(), GetUlBurstProfiles(), Print(), and Serialize().