This class stores the subcarrier groups of all the available HE RUs. More...

#include "he-ru.h"

Collaboration diagram for ns3::HeRu:

Classes
struct	RuSpec
	RU Specification. More...

Public Types
typedef std::pair< uint8_t, RuType >	BwTonesPair
	(bandwidth, number of tones) pair More...

enum	RuType { RU_26_TONE = 0, RU_52_TONE, RU_106_TONE, RU_242_TONE, RU_484_TONE, RU_996_TONE, RU_2x996_TONE }
	The different HE Resource Unit (RU) types. More...

typedef std::vector< SubcarrierRange >	SubcarrierGroup
	a vector of subcarrier ranges defining a subcarrier group More...

typedef std::map< BwTonesPair, std::vector< SubcarrierGroup > >	SubcarrierGroups
	map (bandwidth, number of tones) pairs to the group of subcarrier ranges More...

typedef std::pair< int16_t, int16_t >	SubcarrierRange
	(lowest index, highest index) pair defining a subcarrier range More...

Static Public Member Functions
static uint16_t	GetBandwidth (RuType ruType)
	Get the approximate bandwidth occupied by a RU. More...

static RuType	GetEqualSizedRusForStations (uint16_t bandwidth, std::size_t &nStations)
	Given the channel bandwidth and the number of stations candidate for being assigned an RU, maximize the number of candidate stations that can be assigned an RU subject to the constraint that all the stations must be assigned an RU of the same size (in terms of number of tones). More...

static std::size_t	GetNRus (uint8_t bw, RuType ruType)
	Get the number of distinct RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth. More...

static SubcarrierGroup	GetSubcarrierGroup (uint8_t bw, RuType ruType, std::size_t index)
	Get the subcarrier group of the RU having the given index among all the RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth. More...

Static Public Attributes
static const SubcarrierGroups	m_heRuSubcarrierGroups

Detailed Description

This class stores the subcarrier groups of all the available HE RUs.

Definition at line 35 of file he-ru.h.

Member Typedef Documentation

◆ BwTonesPair

typedef std::pair<uint8_t, RuType> ns3::HeRu::BwTonesPair

(bandwidth, number of tones) pair

Definition at line 148 of file he-ru.h.

◆ SubcarrierGroup

typedef std::vector<SubcarrierRange> ns3::HeRu::SubcarrierGroup

a vector of subcarrier ranges defining a subcarrier group

Definition at line 56 of file he-ru.h.

◆ SubcarrierGroups

typedef std::map<BwTonesPair, std::vector<SubcarrierGroup> > ns3::HeRu::SubcarrierGroups

map (bandwidth, number of tones) pairs to the group of subcarrier ranges

Subcarrier groups for all RUs (with indices being applicable to primary 80 MHz channel)

Definition at line 151 of file he-ru.h.

◆ SubcarrierRange

typedef std::pair<int16_t, int16_t> ns3::HeRu::SubcarrierRange

(lowest index, highest index) pair defining a subcarrier range

Definition at line 53 of file he-ru.h.

Member Enumeration Documentation

◆ RuType

enum ns3::HeRu::RuType

The different HE Resource Unit (RU) types.

Enumerator
RU_26_TONE
RU_52_TONE
RU_106_TONE
RU_242_TONE
RU_484_TONE
RU_996_TONE
RU_2x996_TONE

Definition at line 41 of file he-ru.h.

Member Function Documentation

◆ GetBandwidth()

uint16_t ns3::HeRu::GetBandwidth ( RuType ruType )

static

Get the approximate bandwidth occupied by a RU.

Parameters

ruType the RU type

Returns: the approximate bandwidth (in MHz) occupied by the RU

Definition at line 299 of file he-ru.cc.

References NS_ABORT_MSG, RU_106_TONE, RU_242_TONE, RU_26_TONE, RU_2x996_TONE, RU_484_TONE, RU_52_TONE, and RU_996_TONE.

Referenced by ns3::WifiPhy::EndReceive(), ns3::WifiMode::GetDataRate(), and ns3::WifiPhy::GetReceptionStatus().

Here is the caller graph for this function:

◆ GetEqualSizedRusForStations()

HeRu::RuType ns3::HeRu::GetEqualSizedRusForStations	(	uint16_t	bandwidth,
		std::size_t &	nStations
	)

static

Given the channel bandwidth and the number of stations candidate for being assigned an RU, maximize the number of candidate stations that can be assigned an RU subject to the constraint that all the stations must be assigned an RU of the same size (in terms of number of tones).

Parameters

bandwidth	the channel bandwidth in MHz
nStations	the number of candidate stations. On return, it is set to the number of stations that are assigned an RU

Returns: the RU type

Definition at line 324 of file he-ru.cc.

References m_heRuSubcarrierGroups, NS_ABORT_IF, and RU_2x996_TONE.

◆ GetNRus()

std::size_t ns3::HeRu::GetNRus	(	uint8_t	bw,
		RuType	ruType
	)

static

Get the number of distinct RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth.

Parameters

bw	the bandwidth (MHz) of the HE PPDU (20, 40, 80, 160)
ruType	the RU type (number of tones)

Returns: the number of distinct RUs available

Definition at line 152 of file he-ru.cc.

References m_heRuSubcarrierGroups, and RU_2x996_TONE.

Referenced by GetSubcarrierGroup(), ns3::SpectrumWifiPhy::StartRx(), and ns3::SpectrumWifiPhy::UpdateInterferenceHelperBands().

Here is the caller graph for this function:

◆ GetSubcarrierGroup()

HeRu::SubcarrierGroup ns3::HeRu::GetSubcarrierGroup	(	uint8_t	bw,
		RuType	ruType,
		std::size_t	index
	)

static

Get the subcarrier group of the RU having the given index among all the RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth.

A subcarrier group is defined as one or more pairs indicating the lowest frequency index and the highest frequency index. Note that for channel width of 160 MHz the returned range is relative to the 160 MHz channel (i.e. -1012 to 1012). The index parameter is used to distinguish between primary and secondary 80 MHz subchannels.

Parameters

bw	the bandwidth (MHz) of the HE PPDU (20, 40, 80, 160)
ruType	the RU type (number of tones)
index	the index (starting at 1) of the RU

Returns: the subcarrier range of the specified RU

Definition at line 172 of file he-ru.cc.

References GetNRus(), m_heRuSubcarrierGroups, NS_ABORT_MSG_IF, and RU_2x996_TONE.

Referenced by ns3::WifiPhy::GetRuBand(), ns3::SpectrumWifiPhy::StartRx(), and ns3::SpectrumWifiPhy::UpdateInterferenceHelperBands().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_heRuSubcarrierGroups

const HeRu::SubcarrierGroups ns3::HeRu::m_heRuSubcarrierGroups

static

Definition at line 154 of file he-ru.h.

Referenced by GetEqualSizedRusForStations(), GetNRus(), and GetSubcarrierGroup().

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

src/wifi/model/he-ru.h
src/wifi/model/he-ru.cc

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ BwTonesPair

◆ SubcarrierGroup

◆ SubcarrierGroups

◆ SubcarrierRange

Member Enumeration Documentation

◆ RuType

Member Function Documentation

◆ GetBandwidth()

◆ GetEqualSizedRusForStations()

◆ GetNRus()

◆ GetSubcarrierGroup()

Member Data Documentation

◆ m_heRuSubcarrierGroups