#include <ul-mac-messages.h>

Inheritance diagram for ns3::Ucd:

Collaboration diagram for ns3::Ucd:

Public Member Functions
	Ucd (void)
	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.
virtual	~Ucd (void)
void	AddUlBurstProfile (OfdmUlBurstProfile ulBurstProfile)
uint32_t	Deserialize (Buffer::Iterator start)
OfdmUcdChannelEncodings	GetChannelEncodings (void) const
uint8_t	GetConfigurationChangeCount (void) const
virtual TypeId	GetInstanceTypeId (void) const
std::string	GetName (void) const
uint8_t	GetNrUlBurstProfiles (void) const
uint8_t	GetRangingBackoffEnd (void) const
uint8_t	GetRangingBackoffStart (void) const
uint8_t	GetRequestBackoffEnd (void) const
uint8_t	GetRequestBackoffStart (void) const
uint32_t	GetSerializedSize (void) const
std::vector< OfdmUlBurstProfile >	GetUlBurstProfiles (void) const
void	Print (std::ostream &os) const
void	Serialize (Buffer::Iterator start) const
void	SetChannelEncodings (OfdmUcdChannelEncodings channelEncodings)
void	SetConfigurationChangeCount (uint8_t ucdCount)
void	SetNrUlBurstProfiles (uint8_t nrUlBurstProfiles)
void	SetRangingBackoffEnd (uint8_t rangingBackoffEnd)
void	SetRangingBackoffStart (uint8_t rangingBackoffStart)
void	SetRequestBackoffEnd (uint8_t requestBackoffEnd)
void	SetRequestBackoffStart (uint8_t requestBackoffStart)
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::Ucd.

Private Attributes
OfdmUcdChannelEncodings	m_channelEncodings
uint8_t	m_configurationChangeCount
uint8_t	m_nrUlBurstProfiles
uint8_t	m_rangingBackoffEnd
uint8_t	m_rangingBackoffStart
uint8_t	m_requestBackoffEnd
uint8_t	m_requestBackoffStart
std::vector< OfdmUlBurstProfile >	m_ulBurstProfiles

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

Detailed Description

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

Constructor & Destructor Documentation

ns3::Ucd::Ucd ( void )

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

ns3::Ucd::~Ucd ( void )

virtual

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

Member Function Documentation

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

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

References m_ulBurstProfiles.

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

Here is the caller graph for this function:

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

virtual

Parameters

start an 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 437 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::UcdChannelEncodings::Read(), ns3::OfdmUlBurstProfile::Read(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

OfdmUcdChannelEncodings ns3::Ucd::GetChannelEncodings ( void ) const

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

References m_channelEncodings.

Referenced by ns3::SSLinkManager::PerformBackoff(), ns3::SubscriberStationNetDevice::ProcessUcd(), ns3::SubscriberStationNetDevice::ProcessUlMap(), and ns3::SSLinkManager::SendRangingRequest().

Here is the caller graph for this function:

uint8_t ns3::Ucd::GetConfigurationChangeCount ( void ) const

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

References m_configurationChangeCount.

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

Here is the caller graph for this function:

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

References GetTypeId().

Here is the call graph for this function:

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

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

uint8_t ns3::Ucd::GetNrUlBurstProfiles ( void ) const

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

References m_nrUlBurstProfiles.

uint8_t ns3::Ucd::GetRangingBackoffEnd ( void ) const

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

References m_rangingBackoffEnd.

Referenced by ns3::SSLinkManager::IncreaseRangingRequestCW().

Here is the caller graph for this function:

uint8_t ns3::Ucd::GetRangingBackoffStart ( void ) const

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

References m_rangingBackoffStart.

Referenced by ns3::SubscriberStationNetDevice::ProcessUcd(), and ns3::SSLinkManager::ResetRangingRequestCW().

Here is the caller graph for this function:

uint8_t ns3::Ucd::GetRequestBackoffEnd ( void ) const

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

References m_requestBackoffEnd.

uint8_t ns3::Ucd::GetRequestBackoffStart ( void ) const

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

References m_requestBackoffStart.

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

References ns3::OfdmUcdChannelEncodings::GetSize(), ns3::OfdmUlBurstProfile::GetSize(), m_channelEncodings, and m_ulBurstProfiles.

Here is the call graph for this function:

TypeId ns3::Ucd::GetTypeId ( void )

static

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

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

Reimplemented from ns3::Header.

Definition at line 375 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:

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

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

References m_ulBurstProfiles.

Referenced by ns3::BurstProfileManager::GetBurstProfile(), ns3::BurstProfileManager::GetModulationType(), and ns3::SubscriberStationNetDevice::ProcessUcd().

Here is the caller graph for this function:

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

virtual

Parameters

os output 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 391 of file ul-mac-messages.cc.

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

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

References m_channelEncodings, m_configurationChangeCount, m_rangingBackoffEnd, m_rangingBackoffStart, m_requestBackoffEnd, m_requestBackoffStart, m_ulBurstProfiles, visualizer.core::start(), ns3::UcdChannelEncodings::Write(), ns3::OfdmUlBurstProfile::Write(), and ns3::Buffer::Iterator::WriteU8().