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"

Inheritance diagram for ns3::Ucd:

Collaboration diagram for ns3::Ucd:

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.

Detailed Description

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.

Constructor & Destructor Documentation

◆ Ucd()

ns3::Ucd::Ucd ( )

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

References m_configurationChangeCount, m_nrUlBurstProfiles, m_rangingBackoffEnd, m_rangingBackoffStart, m_requestBackoffEnd, and m_requestBackoffStart.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~Ucd()

ns3::Ucd::~Ucd ( )

override

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

Member Function Documentation

◆ AddUlBurstProfile()

void ns3::Ucd::AddUlBurstProfile ( OfdmUlBurstProfile ulBurstProfile )

Add UL burst profile.

Parameters

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

Here is the caller graph for this function:

◆ Deserialize()

uint32_t ns3::Ucd::Deserialize ( Buffer::Iterator start )

overridevirtual

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

Here is the call graph for this function:

◆ GetChannelEncodings()

OfdmUcdChannelEncodings ns3::Ucd::GetChannelEncodings ( ) const

Get channel encodings.

Returns: the OFDM UCD channel encodings

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

References m_channelEncodings.

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

Here is the caller graph for this function:

◆ GetConfigurationChangeCount()

uint8_t ns3::Ucd::GetConfigurationChangeCount ( ) const

Get configuration change count.

Returns: the configuration change count

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

References m_configurationChangeCount.

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

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Ucd::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

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

References GetTypeId().

Here is the call graph for this function:

◆ GetName()

std::string ns3::Ucd::GetName ( ) const

Get name.

Returns: the name string

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

◆ GetNrUlBurstProfiles()

uint8_t ns3::Ucd::GetNrUlBurstProfiles ( ) const

Get number UL burst profiles.

Returns: the number of UL burst profiles

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

References m_nrUlBurstProfiles.

◆ GetRangingBackoffEnd()

uint8_t ns3::Ucd::GetRangingBackoffEnd ( ) const

Get ranging backoff end.

Returns: the ranging backoff end value

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

References m_rangingBackoffEnd.

◆ GetRangingBackoffStart()

uint8_t ns3::Ucd::GetRangingBackoffStart ( ) const

Get ranging backoff start.

Returns: the ranging backoff start

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

References m_rangingBackoffStart.

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

Here is the caller graph for this function:

◆ GetRequestBackoffEnd()

uint8_t ns3::Ucd::GetRequestBackoffEnd ( ) const

Get request backoff end.

Returns: the request backoff end value

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

References m_requestBackoffEnd.

◆ GetRequestBackoffStart()

uint8_t ns3::Ucd::GetRequestBackoffStart ( ) const

Get request backoff start.

Returns: the request backoff start value

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

References m_requestBackoffStart.

◆ GetSerializedSize()

uint32_t ns3::Ucd::GetSerializedSize ( ) const

overridevirtual

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 388 of file ul-mac-messages.cc.

References m_channelEncodings, and m_ulBurstProfiles.

◆ GetTypeId()

TypeId ns3::Ucd::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References Ucd(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUlBurstProfiles()

std::vector< OfdmUlBurstProfile > ns3::Ucd::GetUlBurstProfiles ( ) const

Get UL burst profiles.

Returns: the UL burst profile

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

References m_ulBurstProfiles.

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

Here is the caller graph for this function:

◆ Print()

void ns3::Ucd::Print ( std::ostream & os ) const

overridevirtual

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 377 of file ul-mac-messages.cc.

References m_configurationChangeCount, m_rangingBackoffEnd, m_rangingBackoffStart, m_requestBackoffEnd, m_requestBackoffStart, and m_ulBurstProfiles.

◆ Serialize()

void ns3::Ucd::Serialize ( Buffer::Iterator start ) const

overridevirtual

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

Here is the call graph for this function: