A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::Dcd Class Reference

Doxygen introspection did not find any typical Config paths. More...

#include <dl-mac-messages.h>

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

Public Member Functions

 Dcd (void)
 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...
 
virtual ~Dcd (void)
 
void AddDlBurstProfile (OfdmDlBurstProfile dlBurstProfile)
 
uint32_t Deserialize (Buffer::Iterator start)
 
OfdmDcdChannelEncodings GetChannelEncodings (void) const
 
uint8_t GetConfigurationChangeCount (void) const
 
std::vector< OfdmDlBurstProfileGetDlBurstProfiles (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
std::string GetName (void) const
 
uint8_t GetNrDlBurstProfiles (void) const
 
uint32_t GetSerializedSize (void) const
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetChannelEncodings (OfdmDcdChannelEncodings channelEncodings)
 
void SetConfigurationChangeCount (uint8_t configurationChangeCount)
 
void SetNrDlBurstProfiles (uint8_t nrDlBurstProfiles)
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

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

Private Attributes

OfdmDcdChannelEncodings m_channelEncodings
 
uint8_t m_configurationChangeCount
 
std::vector< OfdmDlBurstProfilem_dlBurstProfiles
 
uint8_t m_nrDlBurstProfiles
 
uint8_t m_reserved
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Doxygen introspection did not find any typical Config paths.


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

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

Constructor & Destructor Documentation

ns3::Dcd::Dcd ( void  )

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 317 of file dl-mac-messages.cc.

ns3::Dcd::~Dcd ( void  )
virtual

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

Member Function Documentation

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

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

References m_dlBurstProfiles.

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

+ Here is the caller graph for this function:

uint32_t ns3::Dcd::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 438 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 visualizer.core::start().

+ Here is the call graph for this function:

OfdmDcdChannelEncodings ns3::Dcd::GetChannelEncodings ( void  ) const

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

References m_channelEncodings.

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

+ Here is the caller graph for this function:

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

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

References m_configurationChangeCount.

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

+ Here is the caller graph for this function:

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

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

References m_dlBurstProfiles.

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

+ Here is the caller graph for this function:

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

References GetTypeId().

+ Here is the call graph for this function:

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

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

uint8_t ns3::Dcd::GetNrDlBurstProfiles ( void  ) const

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

References m_nrDlBurstProfiles.

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

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

+ Here is the call graph for this function:

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

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

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

References m_configurationChangeCount, and m_dlBurstProfiles.

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

References m_channelEncodings, m_configurationChangeCount, m_dlBurstProfiles, m_reserved, visualizer.core::start(), ns3::DcdChannelEncodings::Write(), ns3::OfdmDlBurstProfile::Write(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

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

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

References m_channelEncodings.

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

+ Here is the caller graph for this function:

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

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

References m_configurationChangeCount.

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

+ Here is the caller graph for this function:

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

Definition at line 341 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

OfdmDcdChannelEncodings ns3::Dcd::m_channelEncodings
private
uint8_t ns3::Dcd::m_configurationChangeCount
private
std::vector<OfdmDlBurstProfile> ns3::Dcd::m_dlBurstProfiles
private
uint8_t ns3::Dcd::m_nrDlBurstProfiles
private

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

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

uint8_t ns3::Dcd::m_reserved
private

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

Referenced by Deserialize(), and Serialize().


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