F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

spectrum: correct Doxygen warnings

Browse Source
This commit is contained in:
Robert Ammon
2017-04-21 21:10:48 -07:00
parent a76d0207fc
commit fe7e8fb07a
2 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/spectrum/model/wifi-spectrum-value-helper.cc
View File

@@ -31,11 +31,17 @@ namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("WifiSpectrumValueHelper");
///< Wifi Spectrum Model structure
struct WifiSpectrumModelId
{
/**
* Constructor
* \param f the frequency in Mhz
* \param w the channel width in Mhz
*/
WifiSpectrumModelId (uint32_t f, uint8_t w);
uint32_t m_centerFrequency;
uint8_t m_channelWidth;
uint32_t m_centerFrequency; ///< center frequency
uint8_t m_channelWidth; ///< channel width
};
WifiSpectrumModelId::WifiSpectrumModelId (uint32_t f, uint8_t w)
@@ -45,13 +51,19 @@ WifiSpectrumModelId::WifiSpectrumModelId (uint32_t f, uint8_t w)
NS_LOG_FUNCTION (this << f << (uint16_t)w);
}
/**
* Less than operator
* \param a the first wifi spectrum to compare
* \param b the second wifi spectrum to compare
* \returns true if the first spectrum is less than the second spectrum
*/
bool
operator < (const WifiSpectrumModelId& a, const WifiSpectrumModelId& b)
{
return ( (a.m_centerFrequency < b.m_centerFrequency) || ( (a.m_centerFrequency == b.m_centerFrequency) && (a.m_channelWidth < b.m_channelWidth)));
}
static std::map<WifiSpectrumModelId, Ptr<SpectrumModel> > g_wifiSpectrumModelMap;
static std::map<WifiSpectrumModelId, Ptr<SpectrumModel> > g_wifiSpectrumModelMap; ///< static initializer for the class
Ptr<SpectrumModel>
WifiSpectrumValueHelper::GetSpectrumModel (uint32_t centerFrequency, uint8_t channelWidth, double bandBandwidth, uint8_t guardBandwidth)
@@ -554,7 +566,7 @@ WifiSpectrumValueHelper::CreateRfFilter (uint32_t centerFrequency, uint8_t chann
return c;
}
static Ptr<SpectrumModel> g_WifiSpectrumModel5Mhz;
static Ptr<SpectrumModel> g_WifiSpectrumModel5Mhz; ///< static initializer for the class
WifiSpectrumValueHelper::~WifiSpectrumValueHelper ()
{

14
src/spectrum/model/wifi-spectrum-value-helper.h
View File

@@ -65,6 +65,7 @@ public:
* \param centerFrequency center frequency (MHz)
* \param txPowerW transmit power (W) to allocate
* \param guardBandwidth width of the guard band (MHz)
* \returns a pointer to a newly allocated SpectrumValue representing the DSSS Transmit Power Spectral Density in W/Hz
*/
static Ptr<SpectrumValue> CreateDsssTxPowerSpectralDensity (uint32_t centerFrequency, double txPowerW, uint8_t guardBandwidth);
@@ -76,6 +77,7 @@ public:
* \param channelWidth channel width (MHz)
* \param txPowerW transmit power (W) to allocate
* \param guardBandwidth width of the guard band (MHz)
* \return a pointer to a newly allocated SpectrumValue representing the OFDM Transmit Power Spectral Density in W/Hz for each Band
*/
static Ptr<SpectrumValue> CreateOfdmTxPowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double txPowerW, uint8_t guardBandwidth);
@@ -88,6 +90,7 @@ public:
* \param channelWidth channel width (MHz)
* \param txPowerW transmit power (W) to allocate
* \param guardBandwidth width of the guard band (MHz)
* \return a pointer to a newly allocated SpectrumValue representing the HT OFDM Transmit Power Spectral Density in W/Hz for each Band
*/
static Ptr<SpectrumValue> CreateHtOfdmTxPowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double txPowerW, uint8_t guardBandwidth);
@@ -100,29 +103,34 @@ public:
* \param channelWidth channel width (MHz)
* \param txPowerW transmit power (W) to allocate
* \param guardBandwidth width of the guard band (MHz)
* \return a pointer to a newly allocated SpectrumValue representing the HE OFDM Transmit Power Spectral Density in W/Hz for each Band
*/
static Ptr<SpectrumValue> CreateHeOfdmTxPowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double txPowerW, uint8_t guardBandwidth);
/**
* Create a power spectral density corresponding to the noise
*
* \param centerFrequency center frequency (MHz)
* \param channelWidth channel width (MHz)
* \param bandBandwidth width of each band (Hz)
* \param noiseFigure the noise figure in dB w.r.t. a reference temperature of 290K
* \param guardBandwidth width of the guard band (MHz)
*
* \return a pointer to a newly allocated SpectrumValue representing the noise Power Spectral Density in W/Hz for each Band
*/
static Ptr<SpectrumValue> CreateNoisePowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double bandBandwidth, double noiseFigure, uint8_t guardBandwidth);
/**
* \param centerFrequency center frequency (MHz)
* \param channelWidth channel width (MHz)
* Create a thermal noise power spectral density
*
* \param noiseFigure the noise figure
* \param spectrumModel the spectrum model
* \return a pointer to a newly allocated SpectrumValue representing the noise Power Spectral Density in W/Hz corresponding to thermal noise, for each Band
*/
static Ptr<SpectrumValue> CreateNoisePowerSpectralDensity (double noiseFigure, Ptr<SpectrumModel> spectrumModel);
/**
* Create a spectral density corresponding to the RF filter
*
* \param centerFrequency center frequency (MHz)
* \param channelWidth channel width (MHz)
* \param bandBandwidth width of each band (Hz)