handles interference calculations More...
#include "interference-helper.h"
Classes | |
class | Event |
Signal event for a packet. More... | |
class | NiChange |
Noise and Interference (thus Ni) event. More... | |
struct | SnrPer |
A struct for both SNR and PER. More... | |
Public Member Functions | |
InterferenceHelper () | |
~InterferenceHelper () | |
Ptr< InterferenceHelper::Event > | Add (Ptr< const Packet > packet, WifiTxVector txVector, Time duration, double rxPower) |
Add the packet-related signal to interference helper. More... | |
void | AddForeignSignal (Time duration, double rxPower) |
Add a non-Wifi signal to interference helper. More... | |
struct InterferenceHelper::SnrPer | CalculatePlcpHeaderSnrPer (Ptr< InterferenceHelper::Event > event) |
Calculate the SNIR at the start of the plcp header and accumulate all SNIR changes in the snir vector. More... | |
struct InterferenceHelper::SnrPer | CalculatePlcpPayloadSnrPer (Ptr< InterferenceHelper::Event > event) |
Calculate the SNIR at the start of the plcp payload and accumulate all SNIR changes in the snir vector. More... | |
void | EraseEvents (void) |
Erase all events. More... | |
Time | GetEnergyDuration (double energyW) const |
Ptr< ErrorRateModel > | GetErrorRateModel (void) const |
Return the error rate model. More... | |
double | GetNoiseFigure (void) const |
Return the noise figure. More... | |
void | NotifyRxEnd () |
Notify that RX has ended. More... | |
void | NotifyRxStart () |
Notify that RX has started. More... | |
void | SetErrorRateModel (const Ptr< ErrorRateModel > rate) |
Set the error rate model for this interference helper. More... | |
void | SetNoiseFigure (double value) |
Set the noise figure. More... | |
void | SetNumberOfReceiveAntennas (uint8_t rx) |
Set the number of RX antennas in the receiver corresponding to this interference helper. More... | |
Private Types | |
typedef std::vector< NiChange > | NiChanges |
typedef for a vector of NiChanges More... | |
Private Member Functions | |
void | AddNiChangeEvent (NiChange change) |
Add NiChange to the list at the appropriate position. More... | |
void | AppendEvent (Ptr< Event > event) |
Append the given Event. More... | |
double | CalculateChunkSuccessRate (double snir, Time duration, WifiMode mode, WifiTxVector txVector) const |
Calculate the success rate of the chunk given the SINR, duration, and Wi-Fi mode. More... | |
double | CalculateNoiseInterferenceW (Ptr< Event > event, NiChanges *ni) const |
Calculate noise and interference power in W. More... | |
double | CalculatePlcpHeaderPer (Ptr< const Event > event, NiChanges *ni) const |
Calculate the error rate of the plcp header. More... | |
double | CalculatePlcpPayloadPer (Ptr< const Event > event, NiChanges *ni) const |
Calculate the error rate of the given plcp payload. More... | |
double | CalculateSnr (double signal, double noiseInterference, uint8_t channelWidth) const |
Calculate SNR (linear ratio) from the given signal power and noise+interference power. More... | |
NiChanges::const_iterator | GetPosition (Time moment) |
Returns a const iterator to the first nichange, which is later than moment. More... | |
Private Attributes | |
Ptr< ErrorRateModel > | m_errorRateModel |
error rate model More... | |
double | m_firstPower |
first power More... | |
NiChanges | m_niChanges |
Experimental: needed for energy duration calculation. More... | |
double | m_noiseFigure |
noise figure (linear) More... | |
uint8_t | m_numRxAntennas |
the number of RX antennas in the corresponding receiver More... | |
bool | m_rxing |
flag whether it is in receiving state More... | |
handles interference calculations
Definition at line 35 of file interference-helper.h.
|
private |
typedef for a vector of NiChanges
Definition at line 261 of file interference-helper.h.
ns3::InterferenceHelper::InterferenceHelper | ( | ) |
Definition at line 133 of file interference-helper.cc.
ns3::InterferenceHelper::~InterferenceHelper | ( | ) |
Definition at line 141 of file interference-helper.cc.
References EraseEvents(), and m_errorRateModel.
Ptr< InterferenceHelper::Event > ns3::InterferenceHelper::Add | ( | Ptr< const Packet > | packet, |
WifiTxVector | txVector, | ||
Time | duration, | ||
double | rxPower | ||
) |
Add the packet-related signal to interference helper.
packet | the packet |
txVector | TXVECTOR of the packet |
duration | the duration of the signal |
rxPower | receive power (W) |
Definition at line 148 of file interference-helper.cc.
References AppendEvent().
Referenced by AddForeignSignal(), and ns3::WifiPhy::StartReceivePreambleAndHeader().
void ns3::InterferenceHelper::AddForeignSignal | ( | Time | duration, |
double | rxPower | ||
) |
Add a non-Wifi signal to interference helper.
duration | the duration of the signal |
rxPower | receive power (W) |
Definition at line 157 of file interference-helper.cc.
References Add().
Referenced by ns3::SpectrumWifiPhy::StartRx().
|
private |
Add NiChange to the list at the appropriate position.
change |
Definition at line 885 of file interference-helper.cc.
References GetPosition(), ns3::InterferenceHelper::NiChange::GetTime(), and m_niChanges.
Referenced by AppendEvent().
Append the given Event.
event |
Definition at line 220 of file interference-helper.cc.
References AddNiChangeEvent(), GetPosition(), m_firstPower, m_niChanges, m_rxing, and ns3::Simulator::Now().
Referenced by Add().
|
private |
Calculate the success rate of the chunk given the SINR, duration, and Wi-Fi mode.
The duration and mode are used to calculate how many bits are present in the chunk.
snir | SINR |
duration | |
mode | |
txVector |
Definition at line 300 of file interference-helper.cc.
References ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetModulationClass(), ns3::WifiTxVector::GetNss(), ns3::WifiTxVector::GetNTx(), ns3::WifiMode::GetPhyRate(), ns3::Time::GetSeconds(), ns3::Time::IsZero(), m_errorRateModel, m_numRxAntennas, NS_LOG_DEBUG, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.
Referenced by CalculatePlcpHeaderPer(), and CalculatePlcpPayloadPer().
|
private |
Calculate noise and interference power in W.
event | |
ni |
Definition at line 258 of file interference-helper.cc.
References m_firstPower, and m_niChanges.
Referenced by CalculatePlcpHeaderSnrPer(), and CalculatePlcpPayloadSnrPer().
|
private |
Calculate the error rate of the plcp header.
The plcp header can be divided into multiple chunks (e.g. due to interference from other transmissions).
event | |
ni |
Definition at line 373 of file interference-helper.cc.
References CalculateChunkSuccessRate(), CalculateSnr(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiPhy::GetHePlcpHeaderMode(), ns3::WifiPhy::GetHtPlcpHeaderMode(), ns3::WifiPhy::GetPlcpHeaderDuration(), ns3::WifiPhy::GetPlcpHeaderMode(), ns3::WifiPhy::GetPlcpHtSigHeaderDuration(), ns3::WifiPhy::GetPlcpPreambleDuration(), ns3::WifiPhy::GetPlcpSigA1Duration(), ns3::WifiPhy::GetPlcpSigA2Duration(), ns3::WifiPhy::GetPlcpSigBDuration(), ns3::WifiPhy::GetPlcpTrainingSymbolDuration(), ns3::WifiTxVector::GetPreambleType(), ns3::WifiPhy::GetVhtPlcpHeaderMode(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WIFI_PREAMBLE_HE_SU, ns3::WIFI_PREAMBLE_HT_GF, ns3::WIFI_PREAMBLE_HT_MF, ns3::WIFI_PREAMBLE_LONG, ns3::WIFI_PREAMBLE_SHORT, and ns3::WIFI_PREAMBLE_VHT.
Referenced by CalculatePlcpHeaderSnrPer().
struct InterferenceHelper::SnrPer ns3::InterferenceHelper::CalculatePlcpHeaderSnrPer | ( | Ptr< InterferenceHelper::Event > | event | ) |
Calculate the SNIR at the start of the plcp header and accumulate all SNIR changes in the snir vector.
event | the event corresponding to the first time the corresponding packet arrives |
Definition at line 851 of file interference-helper.cc.
References CalculateNoiseInterferenceW(), CalculatePlcpHeaderPer(), CalculateSnr(), ns3::InterferenceHelper::SnrPer::per, and ns3::InterferenceHelper::SnrPer::snr.
Referenced by ns3::WifiPhy::StartReceivePacket().
|
private |
Calculate the error rate of the given plcp payload.
The plcp payload can be divided into multiple chunks (e.g. due to interference from other transmissions).
event | |
ni |
Definition at line 320 of file interference-helper.cc.
References CalculateChunkSuccessRate(), CalculateSnr(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiPhy::GetPlcpHeaderDuration(), ns3::WifiPhy::GetPlcpHtSigHeaderDuration(), ns3::WifiPhy::GetPlcpPreambleDuration(), ns3::WifiPhy::GetPlcpSigA1Duration(), ns3::WifiPhy::GetPlcpSigA2Duration(), ns3::WifiPhy::GetPlcpSigBDuration(), ns3::WifiPhy::GetPlcpTrainingSymbolDuration(), ns3::WifiTxVector::GetPreambleType(), NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by CalculatePlcpPayloadSnrPer().
struct InterferenceHelper::SnrPer ns3::InterferenceHelper::CalculatePlcpPayloadSnrPer | ( | Ptr< InterferenceHelper::Event > | event | ) |
Calculate the SNIR at the start of the plcp payload and accumulate all SNIR changes in the snir vector.
event | the event corresponding to the first time the corresponding packet arrives |
Definition at line 831 of file interference-helper.cc.
References CalculateNoiseInterferenceW(), CalculatePlcpPayloadPer(), CalculateSnr(), ns3::InterferenceHelper::SnrPer::per, and ns3::InterferenceHelper::SnrPer::snr.
Referenced by ns3::WifiPhy::EndReceive().
|
private |
Calculate SNR (linear ratio) from the given signal power and noise+interference power.
(Mode is not currently used)
signal | |
noiseInterference | |
channelWidth |
Definition at line 243 of file interference-helper.cc.
References m_noiseFigure, and NS_LOG_DEBUG.
Referenced by CalculatePlcpHeaderPer(), CalculatePlcpHeaderSnrPer(), CalculatePlcpPayloadPer(), and CalculatePlcpPayloadSnrPer().
void ns3::InterferenceHelper::EraseEvents | ( | void | ) |
Erase all events.
Definition at line 871 of file interference-helper.cc.
References m_firstPower, m_niChanges, and m_rxing.
Referenced by ns3::WifiPhy::DoChannelSwitch(), ns3::WifiPhy::DoFrequencySwitch(), and ~InterferenceHelper().
Time ns3::InterferenceHelper::GetEnergyDuration | ( | double | energyW | ) | const |
energyW | the minimum energy (W) requested |
Definition at line 197 of file interference-helper.cc.
References m_firstPower, m_niChanges, ns3::MicroSeconds(), and ns3::Simulator::Now().
Referenced by ns3::WifiPhy::MaybeCcaBusyDuration(), ns3::WifiPhy::ResumeFromSleep(), and ns3::WifiPhy::SwitchMaybeToCcaBusy().
Ptr< ErrorRateModel > ns3::InterferenceHelper::GetErrorRateModel | ( | void | ) | const |
Return the error rate model.
Definition at line 185 of file interference-helper.cc.
References m_errorRateModel.
Referenced by ns3::WifiPhy::CalculateSnr(), and ns3::WifiPhy::GetErrorRateModel().
double ns3::InterferenceHelper::GetNoiseFigure | ( | void | ) | const |
Return the noise figure.
Definition at line 173 of file interference-helper.cc.
References m_noiseFigure.
Referenced by ns3::WifiPhy::GetRxNoiseFigure().
|
private |
Returns a const iterator to the first nichange, which is later than moment.
moment | time to check from |
Definition at line 879 of file interference-helper.cc.
References m_niChanges.
Referenced by AddNiChangeEvent(), and AppendEvent().
void ns3::InterferenceHelper::NotifyRxEnd | ( | ) |
Notify that RX has ended.
Definition at line 898 of file interference-helper.cc.
References m_rxing, and NS_LOG_FUNCTION.
Referenced by ns3::WifiPhy::AbortCurrentReception(), ns3::WifiPhy::EndReceive(), and ns3::WifiPhy::SendPacket().
void ns3::InterferenceHelper::NotifyRxStart | ( | void | ) |
Notify that RX has started.
Definition at line 891 of file interference-helper.cc.
References m_rxing, and NS_LOG_FUNCTION.
Referenced by ns3::WifiPhy::StartRx().
void ns3::InterferenceHelper::SetErrorRateModel | ( | const Ptr< ErrorRateModel > | rate | ) |
Set the error rate model for this interference helper.
rate | Error rate model |
Definition at line 179 of file interference-helper.cc.
References m_errorRateModel.
Referenced by ns3::WifiPhy::SetErrorRateModel().
void ns3::InterferenceHelper::SetNoiseFigure | ( | double | value | ) |
Set the noise figure.
value | noise figure |
Definition at line 167 of file interference-helper.cc.
References m_noiseFigure.
Referenced by ns3::WifiPhy::SetRxNoiseFigure().
void ns3::InterferenceHelper::SetNumberOfReceiveAntennas | ( | uint8_t | rx | ) |
Set the number of RX antennas in the receiver corresponding to this interference helper.
rx | the number of RX antennas |
Definition at line 191 of file interference-helper.cc.
References m_numRxAntennas.
Referenced by ns3::WifiPhy::SetErrorRateModel(), ns3::WifiPhy::SetNumberOfAntennas(), and ns3::WifiPhy::SetRxNoiseFigure().
|
private |
error rate model
Definition at line 323 of file interference-helper.h.
Referenced by CalculateChunkSuccessRate(), GetErrorRateModel(), SetErrorRateModel(), and ~InterferenceHelper().
|
private |
first power
Definition at line 327 of file interference-helper.h.
Referenced by AppendEvent(), CalculateNoiseInterferenceW(), EraseEvents(), and GetEnergyDuration().
|
private |
Experimental: needed for energy duration calculation.
Definition at line 326 of file interference-helper.h.
Referenced by AddNiChangeEvent(), AppendEvent(), CalculateNoiseInterferenceW(), EraseEvents(), GetEnergyDuration(), and GetPosition().
|
private |
noise figure (linear)
Definition at line 322 of file interference-helper.h.
Referenced by CalculateSnr(), GetNoiseFigure(), and SetNoiseFigure().
|
private |
the number of RX antennas in the corresponding receiver
Definition at line 324 of file interference-helper.h.
Referenced by CalculateChunkSuccessRate(), and SetNumberOfReceiveAntennas().
|
private |
flag whether it is in receiving state
Definition at line 328 of file interference-helper.h.
Referenced by AppendEvent(), EraseEvents(), NotifyRxEnd(), and NotifyRxStart().