Class that keeps track of all information about the current PHY operating channel. More...
#include "wifi-phy-operating-channel.h"
Public Types | |
typedef std::set< FrequencyChannelInfo >::const_iterator | ConstIterator |
Typedef for a const iterator pointing to a channel in the set of available channels. More... | |
Public Member Functions | |
WifiPhyOperatingChannel () | |
Create an uninitialized PHY operating channel. More... | |
virtual | ~WifiPhyOperatingChannel () |
uint16_t | GetFrequency (void) const |
Return the center frequency of the operating channel (in MHz). More... | |
uint8_t | GetNumber (void) const |
Return the channel number identifying the whole operating channel. More... | |
uint16_t | GetPrimaryChannelCenterFrequency (uint16_t primaryChannelWidth) const |
Get the center frequency of the primary channel of the given width. More... | |
uint8_t | GetPrimaryChannelIndex (uint16_t primaryChannelWidth) const |
If the operating channel width is a multiple of 20 MHz, return the index of the primary channel of the given width within the operating channel (0 indicates the 20 MHz subchannel with the lowest center frequency). More... | |
uint8_t | GetPrimaryChannelNumber (uint16_t primaryChannelWidth, WifiStandard standard) const |
Get channel number of the primary channel. More... | |
uint16_t | GetWidth (void) const |
Return the width of the whole operating channel (in MHz). More... | |
bool | IsSet (void) const |
Return true if a valid channel has been set, false otherwise. More... | |
void | Set (uint8_t number, uint16_t frequency, uint16_t width, WifiStandard standard, WifiPhyBand band) |
Set the channel according to the specified parameters if a unique frequency channel matches the specified criteria, or abort the simulation otherwise. More... | |
void | SetDefault (uint16_t width, WifiStandard standard, WifiPhyBand band) |
Set the default channel of the given width and for the given standard and band. More... | |
void | SetPrimary20Index (uint8_t index) |
Set the index of the primary 20 MHz channel (0 indicates the 20 MHz subchannel with the lowest center frequency). More... | |
Static Public Member Functions | |
static ConstIterator | FindFirst (uint8_t number, uint16_t frequency, uint16_t width, WifiStandard standard, WifiPhyBand band, ConstIterator start=m_frequencyChannels.begin()) |
Find the first channel matching the specified parameters. More... | |
static uint8_t | GetDefaultChannelNumber (uint16_t width, WifiStandard standard, WifiPhyBand band) |
Get the default channel number of the given width and for the given standard and band. More... | |
Static Public Attributes | |
static const std::set< FrequencyChannelInfo > | m_frequencyChannels |
Available frequency channels. More... | |
Private Attributes | |
ConstIterator | m_channelIt |
const iterator pointing to the configured frequency channel More... | |
uint8_t | m_primary20Index |
index of the primary20 channel (0 indicates the 20 MHz subchannel with the lowest center frequency) More... | |
Class that keeps track of all information about the current PHY operating channel.
Definition at line 43 of file wifi-phy-operating-channel.h.
typedef std::set<FrequencyChannelInfo>::const_iterator ns3::WifiPhyOperatingChannel::ConstIterator |
Typedef for a const iterator pointing to a channel in the set of available channels.
Definition at line 142 of file wifi-phy-operating-channel.h.
ns3::WifiPhyOperatingChannel::WifiPhyOperatingChannel | ( | ) |
Create an uninitialized PHY operating channel.
Definition at line 267 of file wifi-phy-operating-channel.cc.
References NS_LOG_FUNCTION.
|
virtual |
Definition at line 274 of file wifi-phy-operating-channel.cc.
References NS_LOG_FUNCTION_NOARGS.
|
static |
Find the first channel matching the specified parameters.
number | the channel number (use 0 to leave it unspecified) |
frequency | the channel center frequency in MHz (use 0 to leave it unspecified) |
width | the channel width in MHz (use 0 to leave it unspecified) |
standard | the standard |
band | the PHY band |
start | an iterator pointing to the channel to start the search with |
Definition at line 331 of file wifi-phy-operating-channel.cc.
References third::channel, ns3::GetFrequencyChannelType(), ns3::GetMaximumChannelWidth(), m_frequencyChannels, visualizer.core::start(), and ns3::wifiStandards.
Referenced by GetDefaultChannelNumber(), GetPrimaryChannelNumber(), and Set().
|
static |
Get the default channel number of the given width and for the given standard and band.
width | the channel width in MHz |
standard | the standard |
band | the PHY band |
Definition at line 316 of file wifi-phy-operating-channel.cc.
References FindFirst(), and m_frequencyChannels.
Referenced by ns3::WifiPhy::DoChannelSwitch(), and SetDefault().
uint16_t ns3::WifiPhyOperatingChannel::GetFrequency | ( | void | ) | const |
Return the center frequency of the operating channel (in MHz).
Definition at line 383 of file wifi-phy-operating-channel.cc.
References IsSet(), m_channelIt, and NS_ASSERT.
Referenced by ns3::WifiPhy::GetFrequency(), and GetPrimaryChannelCenterFrequency().
uint8_t ns3::WifiPhyOperatingChannel::GetNumber | ( | void | ) | const |
Return the channel number identifying the whole operating channel.
Definition at line 376 of file wifi-phy-operating-channel.cc.
References IsSet(), m_channelIt, and NS_ASSERT.
Referenced by ns3::WifiPhy::GetChannelNumber().
uint16_t ns3::WifiPhyOperatingChannel::GetPrimaryChannelCenterFrequency | ( | uint16_t | primaryChannelWidth | ) | const |
Get the center frequency of the primary channel of the given width.
primaryChannelWidth | the width of the primary channel in MHz |
Definition at line 433 of file wifi-phy-operating-channel.cc.
References GetFrequency(), GetPrimaryChannelIndex(), GetWidth(), and NS_LOG_FUNCTION.
Referenced by ns3::PhyEntity::GetCenterFrequencyForChannelWidth(), GetPrimaryChannelNumber(), and ns3::SpectrumWifiPhy::StartRx().
uint8_t ns3::WifiPhyOperatingChannel::GetPrimaryChannelIndex | ( | uint16_t | primaryChannelWidth | ) | const |
If the operating channel width is a multiple of 20 MHz, return the index of the primary channel of the given width within the operating channel (0 indicates the 20 MHz subchannel with the lowest center frequency).
Otherwise, return 0.
primaryChannelWidth | the width of the primary channel in MHz |
Definition at line 397 of file wifi-phy-operating-channel.cc.
References GetWidth(), m_primary20Index, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by ns3::HePhy::BuildPpdu(), ns3::HePhy::GetCenterFrequencyForNonOfdmaPart(), ns3::HePhy::GetNonOfdmaBand(), ns3::WifiPhy::GetPrimary20Index(), ns3::WifiPhy::GetPrimaryBand(), GetPrimaryChannelCenterFrequency(), ns3::HePhy::GetRuBandForRx(), and ns3::SpectrumWifiPhy::UpdateInterferenceHelperBands().
uint8_t ns3::WifiPhyOperatingChannel::GetPrimaryChannelNumber | ( | uint16_t | primaryChannelWidth, |
WifiStandard | standard | ||
) | const |
Get channel number of the primary channel.
primaryChannelWidth | the width of the primary channel (MHz) |
standard | the standard |
Definition at line 443 of file wifi-phy-operating-channel.cc.
References FindFirst(), GetPrimaryChannelCenterFrequency(), and m_channelIt.
Referenced by ns3::WifiPhy::GetPrimaryChannelNumber().
uint16_t ns3::WifiPhyOperatingChannel::GetWidth | ( | void | ) | const |
Return the width of the whole operating channel (in MHz).
Definition at line 390 of file wifi-phy-operating-channel.cc.
References IsSet(), m_channelIt, and NS_ASSERT.
Referenced by ns3::WifiPhy::GetChannelWidth(), GetPrimaryChannelCenterFrequency(), GetPrimaryChannelIndex(), and SetPrimary20Index().
bool ns3::WifiPhyOperatingChannel::IsSet | ( | void | ) | const |
Return true if a valid channel has been set, false otherwise.
Definition at line 280 of file wifi-phy-operating-channel.cc.
References m_channelIt, and m_frequencyChannels.
Referenced by ns3::WifiPhy::ConfigureStandard(), SetChannelFrequencyTest::DoRun(), GetFrequency(), GetNumber(), GetWidth(), and ns3::WifiMac::SetWifiPhy().
void ns3::WifiPhyOperatingChannel::Set | ( | uint8_t | number, |
uint16_t | frequency, | ||
uint16_t | width, | ||
WifiStandard | standard, | ||
WifiPhyBand | band | ||
) |
Set the channel according to the specified parameters if a unique frequency channel matches the specified criteria, or abort the simulation otherwise.
If the channel width is a multiple of 20 MHz, the primary 20 MHz channel is set to the 20 MHz subchannel with the lowest center frequency.
number | the channel number (use 0 to leave it unspecified) |
frequency | the channel center frequency in MHz (use 0 to leave it unspecified) |
width | the channel width in MHz (use 0 to leave it unspecified) |
standard | the standard |
band | the PHY band |
Definition at line 286 of file wifi-phy-operating-channel.cc.
References FindFirst(), m_channelIt, m_frequencyChannels, m_primary20Index, and NS_LOG_FUNCTION.
Referenced by ns3::WifiPhy::DoChannelSwitch(), and SetDefault().
void ns3::WifiPhyOperatingChannel::SetDefault | ( | uint16_t | width, |
WifiStandard | standard, | ||
WifiPhyBand | band | ||
) |
Set the default channel of the given width and for the given standard and band.
If the channel width is a multiple of 20 MHz, the primary 20 MHz channel is set to the 20 MHz subchannel with the lowest center frequency.
width | the channel width in MHz |
standard | the standard |
band | the PHY band |
Definition at line 308 of file wifi-phy-operating-channel.cc.
References GetDefaultChannelNumber(), NS_LOG_FUNCTION, and Set().
void ns3::WifiPhyOperatingChannel::SetPrimary20Index | ( | uint8_t | index | ) |
Set the index of the primary 20 MHz channel (0 indicates the 20 MHz subchannel with the lowest center frequency).
index | the index of the primary 20 MHz channel |
Definition at line 424 of file wifi-phy-operating-channel.cc.
References GetWidth(), m_primary20Index, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.
Referenced by ns3::WifiPhy::DoChannelSwitch().
|
private |
const iterator pointing to the configured frequency channel
Definition at line 170 of file wifi-phy-operating-channel.h.
Referenced by GetFrequency(), GetNumber(), GetPrimaryChannelNumber(), GetWidth(), IsSet(), and Set().
|
static |
Available frequency channels.
Definition at line 53 of file wifi-phy-operating-channel.h.
Referenced by FindFirst(), GetDefaultChannelNumber(), IsSet(), and Set().
|
private |
index of the primary20 channel (0 indicates the 20 MHz subchannel with the lowest center frequency)
Definition at line 171 of file wifi-phy-operating-channel.h.
Referenced by GetPrimaryChannelIndex(), Set(), and SetPrimary20Index().