25 #include "ns3/abort.h"
26 #include "ns3/eht-phy.h"
49 m_triggerResponding(false),
50 m_modeInitialized(false),
51 m_inactiveSubchannels(),
53 m_center26ToneRuIndication(std::nullopt),
61 uint16_t guardInterval,
65 uint16_t channelWidth,
71 bool triggerResponding)
73 m_txPowerLevel(powerLevel),
75 m_channelWidth(channelWidth),
76 m_guardInterval(guardInterval),
80 m_aggregation(aggregation),
85 m_triggerResponding(triggerResponding),
86 m_modeInitialized(true),
87 m_inactiveSubchannels(),
89 m_center26ToneRuIndication(std::nullopt),
95 : m_mode(txVector.m_mode),
96 m_txPowerLevel(txVector.m_txPowerLevel),
97 m_preamble(txVector.m_preamble),
98 m_channelWidth(txVector.m_channelWidth),
99 m_guardInterval(txVector.m_guardInterval),
100 m_nTx(txVector.m_nTx),
101 m_nss(txVector.m_nss),
102 m_ness(txVector.m_ness),
103 m_aggregation(txVector.m_aggregation),
104 m_stbc(txVector.m_stbc),
105 m_ldpc(txVector.m_ldpc),
106 m_bssColor(txVector.m_bssColor),
107 m_length(txVector.m_length),
108 m_triggerResponding(txVector.m_triggerResponding),
109 m_modeInitialized(txVector.m_modeInitialized),
110 m_inactiveSubchannels(txVector.m_inactiveSubchannels),
111 m_sigBMcs(txVector.m_sigBMcs),
112 m_ruAllocation(txVector.m_ruAllocation),
113 m_center26ToneRuIndication(txVector.m_center26ToneRuIndication),
114 m_ehtPpduType(txVector.m_ehtPpduType)
121 m_muUserInfos.insert(std::make_pair(info.first, info.second));
143 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU (" << staId <<
")");
207 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU (" << staId <<
")");
223 nss = (nss < info.second.nss) ? info.second.nss : nss;
240 nss = std::accumulate(
244 [](uint8_t prevNss,
const auto& info) { return prevNss + info.second.nss; });
294 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU");
339 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU");
460 if (modeName ==
"VhtMcs9")
470 if (modeName ==
"VhtMcs6")
477 if (modeName ==
"VhtMcs9")
487 if (modeName ==
"VhtMcs9")
500 std::map<HeRu::RuSpec, uint8_t> streamsPerRu{};
503 auto it = streamsPerRu.find(info.second.ru);
504 if (it == streamsPerRu.end())
506 streamsPerRu[info.second.ru] = info.second.nss;
510 it->second += info.second.nss;
513 for (
auto& streams : streamsPerRu)
515 if (streams.second > 8)
524 "Cannot use OFDM modulation class in the 2.4 GHz band");
527 "ERP-OFDM modulation class can only be used in the 2.4 GHz band");
566 std::set<HeRu::RuSpec> rus{};
569 rus.insert(userInfo.second.ru);
602 [&ru](
const auto& info) ->
bool { return (ru == info.second.ru); });
615 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU");
623 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU");
638 NS_ABORT_MSG_IF(staId > 2048,
"STA-ID should be correctly set for MU");
669 "Only HE (or later) authorized for preamble puncturing");
672 "Preamble puncturing only possible for transmission bandwidth of 80 MHz or larger");
675 "The size of the inactive subchannnels bitmap should be equal to the number of "
676 "20 MHz subchannels");
680 const std::vector<bool>&
696 std::optional<Center26ToneRuIndication>
715 os <<
"TXVECTOR not valid";
722 <<
" FEC coding: " << (v.
IsLdpc() ?
"LDPC" :
"BCC");
738 os <<
" num User Infos: " << userInfoMap.size();
739 for (
auto& ui : userInfoMap)
741 os <<
", {STA-ID: " << ui.first <<
", " << ui.second.ru <<
", MCS: " << +ui.second.mcs
742 <<
", Nss: " << +ui.second.nss <<
"}";
750 if (!puncturedSubchannels.empty())
752 os <<
" Punctured subchannels: ";
753 std::copy(puncturedSubchannels.cbegin(),
754 puncturedSubchannels.cend(),
755 std::ostream_iterator<bool>(os,
", "));
773 return !(*
this == other);
783 const auto ru = userInfo.second.ru;
784 if (
auto it = orderedMap.find(ru); it != orderedMap.end())
786 it->second.emplace(userInfo.first);
790 orderedMap.emplace(userInfo.second.ru, std::set<uint16_t>{userInfo.first});
800 std::vector<HeRu::RuType> ruTypes{};
801 ruTypes.resize(ruAllocations.size());
803 for (
const auto& [ru, staIds] : orderedMap)
805 const auto ruType = ru.GetRuType();
807 const auto isPrimary80MHz = ru.GetPrimary80MHz();
809 auto ruIndex = ru.GetIndex();
815 if ((!isPrimary80MHz) && (ruIndex > 19))
829 (ruBw < 20) ? ((ruIndex - 1) / rusPerSubchannel.size()) : ((ruIndex - 1) * (ruBw / 20));
830 const auto numSubchannelsForRu = (ruBw < 20) ? 1 : (ruBw / 20);
835 if (ruType == ruTypes.at(index))
852 for (
auto i = 0; i < numSubchannelsForRu; ++i)
854 ruTypes.at(index + i) = ruType;
855 ruAllocations.at(index + i) = ruAlloc;
858 return ruAllocations;
864 uint8_t center26ToneRuIndication{0};
868 (userInfo.second.ru.GetIndex() == 19))
870 center26ToneRuIndication |= (userInfo.second.ru.GetPrimary80MHz())
static WifiMode GetEhtMcs(uint8_t index)
Return the EHT MCS corresponding to the provided index.
static WifiMode GetHeMcs(uint8_t index)
Return the HE MCS corresponding to the provided index.
static uint16_t GetBandwidth(RuType ruType)
Get the approximate bandwidth occupied by a RU.
static constexpr uint8_t EMPTY_242_TONE_RU
Empty 242-tone RU identifier.
static std::vector< HeRu::RuSpec > GetRusOfType(uint16_t 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 b...
static uint8_t GetEqualizedRuAllocation(RuType ruType, bool isOdd)
Get the RU_ALLOCATION value for equal size RUs.
represent a single transmission mode
std::string GetUniqueName() const
WifiModulationClass GetModulationClass() const
uint8_t GetMcsValue() const
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
uint16_t m_channelWidth
channel width in MHz
void SetCenter26ToneRuIndication(Center26ToneRuIndication center26ToneRuIndication)
Set CENTER_26_TONE_RU field.
void SetRuAllocation(const RuAllocation &ruAlloc, uint8_t p20Index)
Set RU_ALLOCATION field.
void SetStbc(bool stbc)
Sets if STBC is being used.
void SetNess(uint8_t ness)
Sets the Ness number.
UserInfoMapOrderedByRus GetUserInfoMapOrderedByRus(uint8_t p20Index) const
Get the map of specific user info parameters ordered per increasing frequency RUs.
bool IsTriggerResponding() const
Return true if the Trigger Responding parameter is set to true, false otherwise.
bool m_aggregation
Flag whether the PSDU contains A-MPDU.
void SetEhtPpduType(uint8_t type)
Set the EHT_PPDU_TYPE parameter.
uint8_t GetNumStasInRu(const HeRu::RuSpec &ru) const
Get the number of STAs in a given RU.
uint16_t GetGuardInterval() const
bool IsSigBCompression() const
Indicate whether the Common field is present in the HE-SIG-B field.
void SetTxPowerLevel(uint8_t powerlevel)
Sets the selected transmission power level.
void SetLdpc(bool ldpc)
Sets if LDPC FEC coding is being used.
void SetChannelWidth(uint16_t channelWidth)
Sets the selected channelWidth (in MHz)
uint8_t GetBssColor() const
Get the BSS color.
bool GetModeInitialized() const
const RuAllocation & GetRuAllocation(uint8_t p20Index) const
Get RU_ALLOCATION field.
std::optional< Center26ToneRuIndication > m_center26ToneRuIndication
CENTER_26_TONE_RU field when format is HE_MU and when channel width is set to 80 MHz or larger (Table...
std::vector< bool > m_inactiveSubchannels
Bitmap of inactive subchannels used for preamble puncturing.
WifiMode m_mode
The DATARATE parameter in Table 15-4.
std::map< uint16_t, HeMuUserInfo > HeMuUserInfoMap
map of HE MU specific user info parameters indexed by STA-ID
void SetGuardInterval(uint16_t guardInterval)
Sets the guard interval duration (in nanoseconds)
bool IsValid(WifiPhyBand band=WIFI_PHY_BAND_UNSPECIFIED) const
The standard disallows certain combinations of WifiMode, number of spatial streams,...
std::optional< Center26ToneRuIndication > GetCenter26ToneRuIndication() const
Get CENTER_26_TONE_RU field This field is present if format is HE_MU and when channel width is set to...
void SetTriggerResponding(bool triggerResponding)
Set the Trigger Responding parameter to the given value.
WifiMode GetMode(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the selected payload transmission mode.
RuAllocation m_ruAllocation
RU allocations that are going to be carried in SIG-B common field per Table 27-1 IEEE.
void SetInactiveSubchannels(const std::vector< bool > &inactiveSubchannels)
Set the 20 MHz subchannels that are punctured.
bool IsStbc() const
Check if STBC is used or not.
void SetHeMuUserInfo(uint16_t staId, HeMuUserInfo userInfo)
Set the HE MU user-specific transmission information for the given STA-ID.
WifiPreamble GetPreambleType() const
HeMuUserInfo GetHeMuUserInfo(uint16_t staId) const
Get the HE MU user-specific transmission information for the given STA-ID.
uint8_t m_nTx
number of TX antennas
bool m_triggerResponding
The Trigger Responding parameter.
void SetAggregation(bool aggregation)
Sets if PSDU contains A-MPDU.
HeRu::RuSpec GetRu(uint16_t staId) const
Get the RU specification for the STA-ID.
HeMuUserInfoMap m_muUserInfos
HE MU specific per-user information indexed by station ID (STA-ID) corresponding to the 11 LSBs of th...
uint8_t m_txPowerLevel
The TXPWR_LEVEL parameter in Table 15-4.
bool m_ldpc
LDPC FEC coding if true, BCC otherwise.
uint16_t GetLength() const
Get the LENGTH field of the L-SIG.
uint16_t m_guardInterval
guard interval duration in nanoseconds
bool m_stbc
STBC used or not.
uint8_t m_nss
number of spatial streams
uint8_t GetNssTotal() const
const HeMuUserInfoMap & GetHeMuUserInfoMap() const
Get a const reference to the map HE MU user-specific transmission information indexed by STA-ID.
void SetRu(HeRu::RuSpec ru, uint16_t staId)
Set the RU specification for the STA-ID.
uint8_t GetEhtPpduType() const
Get the EHT_PPDU_TYPE parameter.
bool IsDlOfdma() const
Return true if this TX vector is used for a downlink multi-user transmission using OFDMA.
WifiModulationClass GetModulationClass() const
Get the modulation class specified by this TXVECTOR.
uint8_t GetNss(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the number of spatial streams.
void SetLength(uint16_t length)
Set the LENGTH field of the L-SIG.
uint8_t GetNssMax() const
void SetSigBMode(const WifiMode &mode)
Set the MCS used for SIG-B.
uint16_t m_length
LENGTH field of the L-SIG.
uint8_t m_bssColor
BSS color.
WifiMode m_sigBMcs
MCS_SIG_B per Table 27-1 IEEE 802.11ax-2021.
void SetBssColor(uint8_t color)
Set the BSS color.
bool IsLdpc() const
Check if LDPC FEC coding is used or not.
void SetNTx(uint8_t nTx)
Sets the number of TX antennas.
uint8_t GetTxPowerLevel() const
std::map< HeRu::RuSpec, std::set< uint16_t >, HeRu::RuSpecCompare > UserInfoMapOrderedByRus
map of specific user info parameters ordered per increasing frequency RUs
bool IsAggregation() const
Checks whether the PSDU contains A-MPDU.
uint8_t m_ehtPpduType
EHT_PPDU_TYPE per Table 36-1 IEEE 802.11be D2.3.
bool IsAllocated(uint16_t staId) const
Check if STA ID is allocated.
uint16_t GetChannelWidth() const
WifiPreamble m_preamble
preamble
Center26ToneRuIndication DeriveCenter26ToneRuIndication() const
Derive the CENTER_26_TONE_RU field from the TXVECTOR for which its CENTER_26_TONE_RU has not been set...
RuAllocation DeriveRuAllocation(uint8_t p20Index) const
Derive the RU_ALLOCATION field from the TXVECTOR for which its RU_ALLOCATION field has not been set y...
bool m_modeInitialized
Internal initialization flag.
bool IsDlMuMimo() const
Return true if this TX vector is used for a downlink multi-user transmission using MU-MIMO.
uint8_t m_ness
number of spatial streams in beamforming
bool IsNonHtDuplicate() const
Checks whether this TXVECTOR corresponds to a non-HT duplicate.
void SetMode(WifiMode mode)
Sets the selected payload transmission mode.
WifiMode GetSigBMode() const
Get MCS used for SIG-B.
void SetNss(uint8_t nss)
Sets the number of Nss.
void SetPreambleType(WifiPreamble preamble)
Sets the preamble type.
const std::vector< bool > & GetInactiveSubchannels() const
Get the 20 MHz subchannels that are punctured.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
Center26ToneRuIndication
Enum for the different values for CENTER_26_TONE_RU.
WifiPhyBand
Identifies the PHY band.
WifiModulationClass
This enumeration defines the modulation classes per (Table 10-6 "Modulation classes"; IEEE 802....
@ CENTER_26_TONE_RU_HIGH_80_MHZ_ALLOCATED
@ CENTER_26_TONE_RU_LOW_80_MHZ_ALLOCATED
@ WIFI_PHY_BAND_UNSPECIFIED
Unspecified.
@ WIFI_PHY_BAND_2_4GHZ
The 2.4 GHz band.
@ WIFI_MOD_CLASS_OFDM
OFDM (Clause 17)
@ WIFI_MOD_CLASS_HT
HT (Clause 19)
@ WIFI_MOD_CLASS_EHT
EHT (Clause 36)
@ WIFI_MOD_CLASS_HE
HE (Clause 27)
@ WIFI_MOD_CLASS_ERP_OFDM
ERP-OFDM (18.4)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool IsEht(WifiPreamble preamble)
Return true if a preamble corresponds to an EHT transmission.
WifiModulationClass GetModulationClassForPreamble(WifiPreamble preamble)
Return the modulation class corresponding to the given preamble type.
std::vector< uint8_t > RuAllocation
8 bit RU_ALLOCATION per 20 MHz
bool IsDlMu(WifiPreamble preamble)
Return true if a preamble corresponds to a downlink multi-user transmission.
std::ostream & operator<<(std::ostream &os, const Angles &a)
bool IsUlMu(WifiPreamble preamble)
Return true if a preamble corresponds to a uplink multi-user transmission.
HE MU specific user transmission parameters.
HeRu::RuSpec ru
RU specification.
uint8_t nss
number of spatial streams
bool operator!=(const HeMuUserInfo &other) const
Compare this user info to the given user info.
bool operator==(const HeMuUserInfo &other) const
Compare this user info to the given user info.
Struct providing a function call operator to compare two RUs.
Declaration of the following enums: