A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::OfdmUcdChannelEncodings Class Reference

This class implements the OFDM UCD channel encodings as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 11.3.1 UCD channel encodings, page 651. More...

#include "ul-mac-messages.h"

+ Inheritance diagram for ns3::OfdmUcdChannelEncodings:
+ Collaboration diagram for ns3::OfdmUcdChannelEncodings:

Public Member Functions

 OfdmUcdChannelEncodings ()
 
 ~OfdmUcdChannelEncodings () override
 
uint8_t GetSbchnlFocContCodes () const
 Get SB channel for control codes.
 
uint8_t GetSbchnlReqRegionFullParams () const
 Get SB channel request region full parameters.
 
uint16_t GetSize () const
 Get size.
 
void SetSbchnlFocContCodes (uint8_t sbchnlFocContCodes)
 Set SB channel for control codes.
 
void SetSbchnlReqRegionFullParams (uint8_t sbchnlReqRegionFullParams)
 Set SB channel reguest region full parameters.
 
- Public Member Functions inherited from ns3::UcdChannelEncodings
 UcdChannelEncodings ()
 
virtual ~UcdChannelEncodings ()
 
uint16_t GetBwReqOppSize () const
 Get BW request opp size.
 
uint32_t GetFrequency () const
 Get frequency.
 
uint16_t GetRangReqOppSize () const
 Get range request opp size.
 
uint16_t GetSize () const
 Get size.
 
Buffer::Iterator Read (Buffer::Iterator start)
 Read item.
 
void SetBwReqOppSize (uint16_t bwReqOppSize)
 Set BW request opp size.
 
void SetFrequency (uint32_t frequency)
 Set frequency.
 
void SetRangReqOppSize (uint16_t rangReqOppSize)
 Set range request opp size.
 
Buffer::Iterator Write (Buffer::Iterator start) const
 Write item.
 

Private Member Functions

Buffer::Iterator DoRead (Buffer::Iterator start) override
 Read item.
 
Buffer::Iterator DoWrite (Buffer::Iterator start) const override
 Write item.
 

Private Attributes

uint8_t m_sbchnlFocContCodes
 SB channel for control codes.
 
uint8_t m_sbchnlReqRegionFullParams
 SB channel request region full parameters.
 

Detailed Description

This class implements the OFDM UCD channel encodings as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 11.3.1 UCD channel encodings, page 651.

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

Constructor & Destructor Documentation

◆ OfdmUcdChannelEncodings()

ns3::OfdmUcdChannelEncodings::OfdmUcdChannelEncodings ( )

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

◆ ~OfdmUcdChannelEncodings()

ns3::OfdmUcdChannelEncodings::~OfdmUcdChannelEncodings ( )
override

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

Member Function Documentation

◆ DoRead()

Buffer::Iterator ns3::OfdmUcdChannelEncodings::DoRead ( Buffer::Iterator start)
overrideprivatevirtual

Read item.

Parameters
startthe iterator
Returns
the updated iterator

Implements ns3::UcdChannelEncodings.

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

References m_sbchnlFocContCodes, m_sbchnlReqRegionFullParams, and ns3::Buffer::Iterator::ReadU8().

+ Here is the call graph for this function:

◆ DoWrite()

Buffer::Iterator ns3::OfdmUcdChannelEncodings::DoWrite ( Buffer::Iterator start) const
overrideprivatevirtual

Write item.

Parameters
startthe iterator
Returns
the updated iterator

Implements ns3::UcdChannelEncodings.

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

References m_sbchnlFocContCodes, m_sbchnlReqRegionFullParams, and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ GetSbchnlFocContCodes()

uint8_t ns3::OfdmUcdChannelEncodings::GetSbchnlFocContCodes ( ) const

Get SB channel for control codes.

Returns
the channel for control codes

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

References m_sbchnlFocContCodes.

◆ GetSbchnlReqRegionFullParams()

uint8_t ns3::OfdmUcdChannelEncodings::GetSbchnlReqRegionFullParams ( ) const

Get SB channel request region full parameters.

Returns
the channel request region full parameters

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

References m_sbchnlReqRegionFullParams.

◆ GetSize()

uint16_t ns3::OfdmUcdChannelEncodings::GetSize ( ) const

Get size.

Returns
the size

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

References ns3::UcdChannelEncodings::GetSize().

Referenced by ns3::Ucd::GetSerializedSize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetSbchnlFocContCodes()

void ns3::OfdmUcdChannelEncodings::SetSbchnlFocContCodes ( uint8_t sbchnlFocContCodes)

Set SB channel for control codes.

Parameters
sbchnlFocContCodesthe channel control codes

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

References m_sbchnlFocContCodes.

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

+ Here is the caller graph for this function:

◆ SetSbchnlReqRegionFullParams()

void ns3::OfdmUcdChannelEncodings::SetSbchnlReqRegionFullParams ( uint8_t sbchnlReqRegionFullParams)

Set SB channel reguest region full parameters.

Parameters
sbchnlReqRegionFullParamsthe channel request region full parameters

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

References m_sbchnlReqRegionFullParams.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_sbchnlFocContCodes

uint8_t ns3::OfdmUcdChannelEncodings::m_sbchnlFocContCodes
private

SB channel for control codes.

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

Referenced by DoRead(), DoWrite(), GetSbchnlFocContCodes(), and SetSbchnlFocContCodes().

◆ m_sbchnlReqRegionFullParams

uint8_t ns3::OfdmUcdChannelEncodings::m_sbchnlReqRegionFullParams
private

SB channel request region full parameters.

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

Referenced by DoRead(), DoWrite(), GetSbchnlReqRegionFullParams(), and SetSbchnlReqRegionFullParams().


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