A Discrete-Event Network Simulator
API
ns3::Dcd Class Reference

This class implements Downlink channel descriptor 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.1 Downlink Channel Descriptor (DCD) message, page 45. More...

#include "dl-mac-messages.h"

+ Inheritance diagram for ns3::Dcd:
+ Collaboration diagram for ns3::Dcd:

Public Member Functions

 Dcd ()
 
 ~Dcd () override
 
void AddDlBurstProfile (OfdmDlBurstProfile dlBurstProfile)
 Add DL burst profile field. More...
 
uint32_t Deserialize (Buffer::Iterator start) override
 
OfdmDcdChannelEncodings GetChannelEncodings () const
 Get channel encodings field. More...
 
uint8_t GetConfigurationChangeCount () const
 Get configuration change count field. More...
 
std::vector< OfdmDlBurstProfileGetDlBurstProfiles () const
 Get DL burst profile field. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
std::string GetName () const
 Get name field. More...
 
uint8_t GetNrDlBurstProfiles () const
 Get number DL burst profiles field. More...
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
void SetChannelEncodings (OfdmDcdChannelEncodings channelEncodings)
 Set channel encodings field. More...
 
void SetConfigurationChangeCount (uint8_t configurationChangeCount)
 Set configuration change count field. More...
 
void SetNrDlBurstProfiles (uint8_t nrDlBurstProfiles)
 Set number DL burst profile field. More...
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

OfdmDcdChannelEncodings m_channelEncodings
 TLV Encoded information for the overall channel. More...
 
uint8_t m_configurationChangeCount
 configuration change count More...
 
std::vector< OfdmDlBurstProfilem_dlBurstProfiles
 vector of download burst profiles More...
 
uint8_t m_nrDlBurstProfiles
 number DL purst profiles More...
 
uint8_t m_reserved
 changed as per the amendment 802.16e-2005 More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

This class implements Downlink channel descriptor 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.1 Downlink Channel Descriptor (DCD) message, page 45.

Definition at line 365 of file dl-mac-messages.h.

Constructor & Destructor Documentation

◆ Dcd()

ns3::Dcd::Dcd ( )

Definition at line 319 of file dl-mac-messages.cc.

◆ ~Dcd()

ns3::Dcd::~Dcd ( )
override

Definition at line 326 of file dl-mac-messages.cc.

Member Function Documentation

◆ AddDlBurstProfile()

void ns3::Dcd::AddDlBurstProfile ( OfdmDlBurstProfile  dlBurstProfile)

Add DL burst profile field.

Parameters
dlBurstProfilethe DL burst profile

Definition at line 349 of file dl-mac-messages.cc.

References m_dlBurstProfiles.

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

+ Here is the caller graph for this function:

◆ Deserialize()

uint32_t ns3::Dcd::Deserialize ( Buffer::Iterator  start)
overridevirtual
Parameters
startan 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 433 of file dl-mac-messages.cc.

References AddDlBurstProfile(), ns3::Buffer::Iterator::GetDistanceFrom(), m_channelEncodings, m_configurationChangeCount, m_nrDlBurstProfiles, m_reserved, ns3::DcdChannelEncodings::Read(), ns3::OfdmDlBurstProfile::Read(), ns3::Buffer::Iterator::ReadU8(), and two-ray-to-three-gpp-ch-calibration::start.

+ Here is the call graph for this function:

◆ GetChannelEncodings()

OfdmDcdChannelEncodings ns3::Dcd::GetChannelEncodings ( ) const

Get channel encodings field.

Returns
the channel encodings

Definition at line 361 of file dl-mac-messages.cc.

References m_channelEncodings.

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

+ Here is the caller graph for this function:

◆ GetConfigurationChangeCount()

uint8_t ns3::Dcd::GetConfigurationChangeCount ( ) const

Get configuration change count field.

Returns
the configuration change count

Definition at line 355 of file dl-mac-messages.cc.

References m_configurationChangeCount.

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

+ Here is the caller graph for this function:

◆ GetDlBurstProfiles()

std::vector< OfdmDlBurstProfile > ns3::Dcd::GetDlBurstProfiles ( ) const

Get DL burst profile field.

Returns
the DL burst profiles

Definition at line 367 of file dl-mac-messages.cc.

References m_dlBurstProfiles.

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

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Dcd::GetInstanceTypeId ( ) const
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.

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

Implements ns3::ObjectBase.

Definition at line 393 of file dl-mac-messages.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetName()

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

Get name field.

Returns
the name string

Definition at line 379 of file dl-mac-messages.cc.

◆ GetNrDlBurstProfiles()

uint8_t ns3::Dcd::GetNrDlBurstProfiles ( ) const

Get number DL burst profiles field.

Returns
the number of DL burst profiles

Definition at line 373 of file dl-mac-messages.cc.

References m_nrDlBurstProfiles.

◆ GetSerializedSize()

uint32_t ns3::Dcd::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 406 of file dl-mac-messages.cc.

References ns3::OfdmDcdChannelEncodings::GetSize(), m_channelEncodings, and m_dlBurstProfiles.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 385 of file dl-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:

◆ Print()

void ns3::Dcd::Print ( std::ostream &  os) const
overridevirtual
Parameters
osoutput 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 399 of file dl-mac-messages.cc.

References m_configurationChangeCount, and m_dlBurstProfiles.

◆ Serialize()

void ns3::Dcd::Serialize ( Buffer::Iterator  start) const
overridevirtual
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 419 of file dl-mac-messages.cc.

References m_channelEncodings, m_configurationChangeCount, m_dlBurstProfiles, m_reserved, two-ray-to-three-gpp-ch-calibration::start, ns3::DcdChannelEncodings::Write(), ns3::Buffer::Iterator::Write(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetChannelEncodings()

void ns3::Dcd::SetChannelEncodings ( OfdmDcdChannelEncodings  channelEncodings)

Set channel encodings field.

Parameters
channelEncodingsthe channel encodings

Definition at line 337 of file dl-mac-messages.cc.

References m_channelEncodings.

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

+ Here is the caller graph for this function:

◆ SetConfigurationChangeCount()

void ns3::Dcd::SetConfigurationChangeCount ( uint8_t  configurationChangeCount)

Set configuration change count field.

Parameters
configurationChangeCountthe configuration change count

Definition at line 331 of file dl-mac-messages.cc.

References m_configurationChangeCount.

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

+ Here is the caller graph for this function:

◆ SetNrDlBurstProfiles()

void ns3::Dcd::SetNrDlBurstProfiles ( uint8_t  nrDlBurstProfiles)

Set number DL burst profile field.

Parameters
nrDlBurstProfilesthe number of DL burst profiles

Definition at line 343 of file dl-mac-messages.cc.

References m_nrDlBurstProfiles.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_channelEncodings

OfdmDcdChannelEncodings ns3::Dcd::m_channelEncodings
private

TLV Encoded information for the overall channel.

Definition at line 432 of file dl-mac-messages.h.

Referenced by Deserialize(), GetChannelEncodings(), GetSerializedSize(), Serialize(), and SetChannelEncodings().

◆ m_configurationChangeCount

uint8_t ns3::Dcd::m_configurationChangeCount
private

configuration change count

Definition at line 431 of file dl-mac-messages.h.

Referenced by Deserialize(), GetConfigurationChangeCount(), Print(), Serialize(), and SetConfigurationChangeCount().

◆ m_dlBurstProfiles

std::vector<OfdmDlBurstProfile> ns3::Dcd::m_dlBurstProfiles
private

vector of download burst profiles

Definition at line 433 of file dl-mac-messages.h.

Referenced by AddDlBurstProfile(), GetDlBurstProfiles(), GetSerializedSize(), Print(), and Serialize().

◆ m_nrDlBurstProfiles

uint8_t ns3::Dcd::m_nrDlBurstProfiles
private

number DL purst profiles

Definition at line 435 of file dl-mac-messages.h.

Referenced by Deserialize(), GetNrDlBurstProfiles(), and SetNrDlBurstProfiles().

◆ m_reserved

uint8_t ns3::Dcd::m_reserved
private

changed as per the amendment 802.16e-2005

Definition at line 430 of file dl-mac-messages.h.

Referenced by Deserialize(), and Serialize().


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