This class stores the subcarrier groups of all the available HE RUs. More...
#include "he-ru.h"
Classes | |
class | RuSpec |
RU Specification. More... | |
struct | RuSpecCompare |
Struct providing a function call operator to compare two RUs. More... | |
Public Types | |
typedef std::pair< MHz_u, RuType > | BwTonesPair |
(bandwidth, number of tones) pair | |
using | RuAllocationMap = std::map<uint8_t, std::vector<RuSpec>> |
RU allocation map. | |
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 | |
typedef std::map< BwTonesPair, std::vector< SubcarrierGroup > > | SubcarrierGroups |
map (bandwidth, number of tones) pairs to the group of subcarrier ranges | |
typedef std::pair< int16_t, int16_t > | SubcarrierRange |
(lowest index, highest index) pair defining a subcarrier range | |
Static Public Member Functions | |
static bool | DoesOverlap (MHz_u bw, RuSpec ru, const std::vector< RuSpec > &v) |
Check whether the given RU overlaps with the given set of RUs. | |
static bool | DoesOverlap (MHz_u bw, RuSpec ru, const SubcarrierGroup &toneRanges, uint8_t p20Index) |
Check whether the given RU overlaps with the given tone ranges. | |
static RuSpec | FindOverlappingRu (MHz_u bw, RuSpec referenceRu, RuType searchedRuType) |
Find the RU allocation of the given RU type overlapping the given reference RU allocation. | |
static MHz_u | GetBandwidth (RuType ruType) |
Get the approximate bandwidth occupied by a RU. | |
static std::vector< HeRu::RuSpec > | GetCentral26TonesRus (MHz_u bw, HeRu::RuType ruType) |
Get the set of 26-tone RUs that can be additionally allocated if the given bandwidth is split in RUs of the given type. | |
static uint8_t | GetEqualizedRuAllocation (RuType ruType, bool isOdd) |
Get the RU_ALLOCATION value for equal size RUs. | |
static RuType | GetEqualSizedRusForStations (MHz_u bandwidth, std::size_t &nStations, std::size_t &nCentral26TonesRus) |
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). | |
static std::size_t | GetNRus (MHz_u 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. | |
static std::vector< HeRu::RuSpec > | GetRusOfType (MHz_u bw, HeRu::RuType ruType) |
Get the set of distinct RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth. | |
static std::vector< RuSpec > | GetRuSpecs (uint8_t ruAllocation) |
Get the RU specs based on RU_ALLOCATION. | |
static RuType | GetRuType (MHz_u bandwidth) |
Get the RU corresponding to the approximate bandwidth. | |
static SubcarrierGroup | GetSubcarrierGroup (MHz_u bw, RuType ruType, std::size_t phyIndex) |
Get the subcarrier group of the RU having the given PHY index among all the RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth. | |
Static Public Attributes | |
static constexpr uint8_t | EMPTY_242_TONE_RU = 113 |
Empty 242-tone RU identifier. | |
static const RuAllocationMap | m_heRuAllocations |
Table 27-26 of IEEE 802.11ax-2021. | |
static const SubcarrierGroups | m_heRuSubcarrierGroups |
Subcarrier groups for all RUs (with indices being applicable to primary 80 MHz channel) | |
This class stores the subcarrier groups of all the available HE RUs.
typedef std::pair<MHz_u, RuType> ns3::HeRu::BwTonesPair |
using ns3::HeRu::RuAllocationMap = std::map<uint8_t, std::vector<RuSpec>> |
typedef std::vector<SubcarrierRange> ns3::HeRu::SubcarrierGroup |
typedef std::map<BwTonesPair, std::vector<SubcarrierGroup> > ns3::HeRu::SubcarrierGroups |
typedef std::pair<int16_t, int16_t> ns3::HeRu::SubcarrierRange |
enum ns3::HeRu::RuType |
Check whether the given RU overlaps with the given set of RUs.
Note that for channel width of 160 MHz the returned range is relative to the 160 MHz channel (i.e. -1012 to 1012).
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
ru | the given RU allocation |
v | the given set of RUs |
Definition at line 619 of file he-ru.cc.
References ns3::HeRu::RuSpec::GetIndex(), ns3::HeRu::RuSpec::GetPrimary80MHz(), ns3::HeRu::RuSpec::GetRuType(), GetSubcarrierGroup(), and RU_2x996_TONE.
Referenced by FindOverlappingRu(), and ns3::CtrlTriggerHeader::IsValid().
|
static |
Check whether the given RU overlaps with the given tone ranges.
Note that for channel width of 160 MHz the returned range is relative to the 160 MHz channel (i.e. -1012 to 1012).
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
ru | the given RU allocation |
toneRanges | the given set of tone ranges |
p20Index | the index of the primary20 channel |
Definition at line 655 of file he-ru.cc.
References ns3::HeRu::RuSpec::GetPhyIndex(), ns3::HeRu::RuSpec::GetRuType(), GetSubcarrierGroup(), and RU_2x996_TONE.
|
static |
Find the RU allocation of the given RU type overlapping the given reference RU allocation.
Note that an assert is generated if the RU allocation is not found.
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
referenceRu | the reference RU allocation |
searchedRuType | the searched RU type |
Definition at line 678 of file he-ru.cc.
References DoesOverlap(), GetNRus(), ns3::HeRu::RuSpec::GetPrimary80MHz(), NS_ABORT_MSG, and RU_2x996_TONE.
Referenced by ns3::HePhy::GetCenterFrequenciesForNonHePart(), and ns3::HePhy::GetNonOfdmaBand().
Get the approximate bandwidth occupied by a RU.
ruType | the RU type |
Definition at line 756 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 TxDurationTest::CheckMuTxDuration(), ns3::WifiPhyOperatingChannel::Get20MHzIndicesCoveringRu(), ns3::HePhy::GetChannelWidthAndBand(), ns3::EhtPhy::GetDataRateFromTxVector(), ns3::HePhy::GetDataRateFromTxVector(), ns3::HePhy::GetNonOfdmaWidth(), ns3::EhtPhy::GetPhyRateFromTxVector(), ns3::HePhy::GetPhyRateFromTxVector(), ns3::HePhy::GetTxPowerSpectralDensity(), TestMultipleHeTbPreambles::RxHeTbPpdu(), and ns3::HePpdu::SetHeMuUserInfos().
|
static |
Get the set of 26-tone RUs that can be additionally allocated if the given bandwidth is split in RUs of the given type.
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
ruType | the RU type (number of tones) |
Definition at line 534 of file he-ru.cc.
References RU_106_TONE, RU_242_TONE, RU_26_TONE, RU_484_TONE, and RU_52_TONE.
|
static |
Get the RU_ALLOCATION value for equal size RUs.
ruType | equal size RU type (generated by GetEqualSizedRusForStations) |
isOdd | if number of stations is an odd number |
Definition at line 414 of file he-ru.cc.
References RU_106_TONE, RU_242_TONE, RU_26_TONE, RU_484_TONE, and RU_52_TONE.
Referenced by WifiPrimaryChannelsTest::SendDlMuPpdu().
|
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).
bandwidth | the channel bandwidth | |
nStations | the number of candidate stations. On return, it is set to the number of stations that are assigned an RU | |
[out] | nCentral26TonesRus | the number of additional 26-tone RUs that can be allocated if the returned RU size is greater than 26 tones |
Definition at line 806 of file he-ru.cc.
References m_heRuSubcarrierGroups, NS_ABORT_IF, RU_106_TONE, RU_242_TONE, RU_2x996_TONE, RU_484_TONE, and RU_52_TONE.
Referenced by ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().
Get the number of distinct RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth.
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
ruType | the RU type (number of tones) |
Definition at line 484 of file he-ru.cc.
References m_heRuSubcarrierGroups, and RU_2x996_TONE.
Referenced by WifiPrimaryChannelsTest::DoRun(), FindOverlappingRu(), ns3::WifiPhyOperatingChannel::Get20MHzIndicesCoveringRu(), ns3::SpectrumWifiPhy::GetHeRuBands(), ns3::HeRu::RuSpec::GetPhyIndex(), and GetSubcarrierGroup().
|
static |
Get the set of distinct RUs of the given type (number of tones) available in a HE PPDU of the given bandwidth.
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
ruType | the RU type (number of tones) |
Definition at line 504 of file he-ru.cc.
References m_heRuSubcarrierGroups, NS_ASSERT, and RU_2x996_TONE.
Referenced by ns3::HePpdu::SetHeMuUserInfos().
|
static |
Get the RU specs based on RU_ALLOCATION.
ruAllocation | 8 bit RU_ALLOCATION value |
Definition at line 382 of file he-ru.cc.
References m_heRuAllocations, and NS_FATAL_ERROR.
Referenced by ns3::HePpdu::SetHeMuUserInfos().
|
static |
Get the RU corresponding to the approximate bandwidth.
bandwidth | the approximate bandwidth occupied by the RU |
Definition at line 781 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::HePhy::GetCenterFrequenciesForNonHePart(), ns3::HePhy::GetNonOfdmaBand(), ns3::WifiPhyHelper::GetRadiotapHeader(), TestUlMuMimoPhyTransmission::GetTxVectorForHeTbPpdu(), TestDlMuMimoPhyTransmission::SendMuPpdu(), and TestUlMuMimoPhyTransmission::SetTrigVector().
|
static |
Get the subcarrier group of the RU having the given PHY 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 PHY index parameter is used to distinguish between lower and higher 80 MHz subchannels.
bw | the bandwidth of the HE PPDU (20, 40, 80, 160) |
ruType | the RU type (number of tones) |
phyIndex | the PHY index (starting at 1) of the RU |
Definition at line 580 of file he-ru.cc.
References GetNRus(), m_heRuSubcarrierGroups, NS_ABORT_MSG_IF, and RU_2x996_TONE.
Referenced by DoesOverlap(), DoesOverlap(), ns3::SpectrumWifiPhy::GetHeRuBands(), ns3::HePhy::GetNonOfdmaBand(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), and ns3::HeRu::RuSpecCompare::operator()().
|
staticconstexpr |
|
static |
Table 27-26 of IEEE 802.11ax-2021.
Definition at line 288 of file he-ru.h.
Referenced by GetRuSpecs().
|
static |
Subcarrier groups for all RUs (with indices being applicable to primary 80 MHz channel)
Definition at line 282 of file he-ru.h.
Referenced by GetEqualSizedRusForStations(), GetNRus(), GetRusOfType(), and GetSubcarrierGroup().