A Discrete-Event Network Simulator
API
interference-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef INTERFERENCE_HELPER_H
22 #define INTERFERENCE_HELPER_H
23 
24 #include "ns3/nstime.h"
25 #include "wifi-tx-vector.h"
26 #include <map>
27 
28 namespace ns3 {
29 
30 class Packet;
31 class ErrorRateModel;
32 
38 class Event : public SimpleRefCount<Event>
39 {
40 public:
49  Event (Ptr<const Packet> packet, WifiTxVector txVector, Time duration, double rxPower);
50  ~Event ();
51 
56  Ptr<const Packet> GetPacket (void) const;
62  Time GetStartTime (void) const;
68  Time GetEndTime (void) const;
74  double GetRxPowerW (void) const;
80  WifiTxVector GetTxVector (void) const;
86  WifiMode GetPayloadMode (void) const;
87 
88 
89 private:
94  double m_rxPowerW;
95 };
96 
102 {
103 public:
111  struct SnrPer
112  {
113  double snr;
114  double per;
115  };
116 
119 
125  void SetNoiseFigure (double value);
131  void SetErrorRateModel (const Ptr<ErrorRateModel> rate);
132 
145  void SetNumberOfReceiveAntennas (uint8_t rx);
146 
154  Time GetEnergyDuration (double energyW) const;
155 
166  Ptr<Event> Add (Ptr<const Packet> packet, WifiTxVector txVector, Time duration, double rxPower);
167 
173  void AddForeignSignal (Time duration, double rxPower);
186  struct InterferenceHelper::SnrPer CalculatePayloadSnrPer (Ptr<Event> event, std::pair<Time, Time> relativeMpduStartStop) const;
194  double CalculateSnr (Ptr<Event> event) const;
203  struct InterferenceHelper::SnrPer CalculateNonHtPhyHeaderSnrPer (Ptr<Event> event) const;
212  struct InterferenceHelper::SnrPer CalculateHtPhyHeaderSnrPer (Ptr<Event> event) const;
213 
217  void NotifyRxStart ();
221  void NotifyRxEnd ();
225  void EraseEvents (void);
226 
227 
228 private:
232  class NiChange
233  {
234 public:
241  NiChange (double power, Ptr<Event> event);
247  double GetPower (void) const;
253  void AddPower (double power);
259  Ptr<Event> GetEvent (void) const;
260 
261 
262 private:
263  double m_power;
265  };
266 
270  typedef std::multimap<Time, NiChange> NiChanges;
271 
277  void AppendEvent (Ptr<Event> event);
286  double CalculateNoiseInterferenceW (Ptr<Event> event, NiChanges *ni) const;
296  double CalculateSnr (double signal, double noiseInterference, uint16_t channelWidth) const;
308  double CalculateChunkSuccessRate (double snir, Time duration, WifiMode mode, WifiTxVector txVector) const;
319  double CalculatePayloadChunkSuccessRate (double snir, Time duration, WifiTxVector txVector) const;
331  double CalculatePayloadPer (Ptr<const Event> event, NiChanges *ni, std::pair<Time, Time> window) const;
341  double CalculateNonHtPhyHeaderPer (Ptr<const Event> event, NiChanges *ni) const;
351  double CalculateHtPhyHeaderPer (Ptr<const Event> event, NiChanges *ni) const;
352 
353  double m_noiseFigure;
355  uint8_t m_numRxAntennas;
358  double m_firstPower;
359  bool m_rxing;
360 
367  NiChanges::const_iterator GetNextPosition (Time moment) const;
374  //NiChanges::iterator GetNextPosition (Time moment);
381  NiChanges::const_iterator GetPreviousPosition (Time moment) const;
382 
391  NiChanges::iterator AddNiChangeEvent (Time moment, NiChange change);
392 };
393 
394 } //namespace ns3
395 
396 #endif /* INTERFERENCE_HELPER_H */
double GetRxPowerW(void) const
Return the receive power (w).
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
void AddForeignSignal(Time duration, double rxPower)
Add a non-Wifi signal to interference helper.
Signal event for a packet.
NiChanges::iterator AddNiChangeEvent(Time moment, NiChange change)
Add NiChange to the list at the appropriate position and return the iterator of the new event...
void SetNumberOfReceiveAntennas(uint8_t rx)
Set the number of RX antennas in the receiver corresponding to this interference helper.
double m_rxPowerW
receive power in watts
Ptr< ErrorRateModel > GetErrorRateModel(void) const
Return the error rate model.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Time GetEndTime(void) const
Return the end time of the signal.
handles interference calculations
double CalculateNonHtPhyHeaderPer(Ptr< const Event > event, NiChanges *ni) const
Calculate the error rate of the non-HT PHY header.
void SetErrorRateModel(const Ptr< ErrorRateModel > rate)
Set the error rate model for this interference helper.
Time GetStartTime(void) const
Return the start time of the signal.
STL namespace.
Ptr< ErrorRateModel > m_errorRateModel
error rate model
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:97
struct InterferenceHelper::SnrPer CalculateNonHtPhyHeaderSnrPer(Ptr< Event > event) const
Calculate the SNIR at the start of the non-HT PHY header and accumulate all SNIR changes in the snir ...
Event(Ptr< const Packet > packet, WifiTxVector txVector, Time duration, double rxPower)
Create an Event with the given parameters.
WifiMode GetPayloadMode(void) const
Return the Wi-Fi mode used for the payload.
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. ...
Time GetEnergyDuration(double energyW) const
Ptr< Event > Add(Ptr< const Packet > packet, WifiTxVector txVector, Time duration, double rxPower)
Add the packet-related signal to interference helper.
NiChanges m_niChanges
Experimental: needed for energy duration calculation.
double CalculatePayloadChunkSuccessRate(double snir, Time duration, WifiTxVector txVector) const
Calculate the success rate of the payload chunk given the SINR, duration, and Wi-Fi mode...
Ptr< const Packet > GetPacket(void) const
Return the packet.
double CalculateNoiseInterferenceW(Ptr< Event > event, NiChanges *ni) const
Calculate noise and interference power in W.
WifiTxVector GetTxVector(void) const
Return the TXVECTOR of the packet.
double m_noiseFigure
noise figure (linear)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void NotifyRxStart()
Notify that RX has started.
Noise and Interference (thus Ni) event.
void EraseEvents(void)
Erase all events.
struct InterferenceHelper::SnrPer CalculateHtPhyHeaderSnrPer(Ptr< Event > event) const
Calculate the SNIR at the start of the HT PHY header and accumulate all SNIR changes in the snir vect...
double CalculateSnr(Ptr< Event > event) const
Calculate the SNIR for the event (starting from now until the event end).
uint8_t m_numRxAntennas
the number of RX antennas in the corresponding receiver
double CalculateHtPhyHeaderPer(Ptr< const Event > event, NiChanges *ni) const
Calculate the error rate of the HT PHY header.
struct InterferenceHelper::SnrPer CalculatePayloadSnrPer(Ptr< Event > event, std::pair< Time, Time > relativeMpduStartStop) const
Calculate the SNIR at the start of the payload and accumulate all SNIR changes in the snir vector for...
void NotifyRxEnd()
Notify that RX has ended.
void SetNoiseFigure(double value)
Set the noise figure.
double m_firstPower
first power
double CalculatePayloadPer(Ptr< const Event > event, NiChanges *ni, std::pair< Time, Time > window) const
Calculate the error rate of the given PLCP payload only in the provided time window (thus enabling pe...
WifiTxVector m_txVector
TXVECTOR.
void AppendEvent(Ptr< Event > event)
Append the given Event.
Time m_endTime
end time
NiChanges::const_iterator GetNextPosition(Time moment) const
Returns an iterator to the first nichange that is later than moment.
handles interference calculations
Ptr< const Packet > m_packet
packet
A template-based reference counting class.
NiChanges::const_iterator GetPreviousPosition(Time moment) const
Returns an iterator to the first nichange that is later than moment.
std::multimap< Time, NiChange > NiChanges
typedef for a multimap of NiChanges
bool m_rxing
flag whether it is in receiving state
Time m_startTime
start time