interference-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef INTERFERENCE_HELPER_H
#define INTERFERENCE_HELPER_H

#include "ns3/nstime.h"
#include "ns3/packet.h"
#include "wifi-tx-vector.h"
#include "error-rate-model.h"

namespace ns3 {

class InterferenceHelper
{
public:
  class Event : public SimpleRefCount<InterferenceHelper::Event>
  {
public:
    Event (Ptr<const Packet> packet, WifiTxVector txVector, Time duration, double rxPower);
    ~Event ();

    Ptr<const Packet> GetPacket (void) const;
    Time GetDuration (void) const;
    Time GetStartTime (void) const;
    Time GetEndTime (void) const;
    double GetRxPowerW (void) const;
    WifiTxVector GetTxVector (void) const;
    WifiMode GetPayloadMode (void) const;


private:
    Ptr<const Packet> m_packet; 
    WifiTxVector m_txVector; 
    Time m_startTime; 
    Time m_endTime; 
    double m_rxPowerW; 
  };

  struct SnrPer
  {
    double snr; 
    double per; 
  };

  InterferenceHelper ();
  ~InterferenceHelper ();

  void SetNoiseFigure (double value);
  void SetErrorRateModel (const Ptr<ErrorRateModel> rate);

  double GetNoiseFigure (void) const;
  Ptr<ErrorRateModel> GetErrorRateModel (void) const;
  void SetNumberOfReceiveAntennas (uint8_t rx);

  Time GetEnergyDuration (double energyW) const;

  Ptr<InterferenceHelper::Event> Add (Ptr<const Packet> packet, WifiTxVector txVector, Time duration, double rxPower);

  void AddForeignSignal (Time duration, double rxPower);
  struct InterferenceHelper::SnrPer CalculatePlcpPayloadSnrPer (Ptr<InterferenceHelper::Event> event);
  struct InterferenceHelper::SnrPer CalculatePlcpHeaderSnrPer (Ptr<InterferenceHelper::Event> event);

  void NotifyRxStart ();
  void NotifyRxEnd ();
  void EraseEvents (void);


private:
  class NiChange
  {
public:
    NiChange (Time time, double delta, Ptr<InterferenceHelper::Event> event);
    Time GetTime (void) const;
    double GetDelta (void) const;
    Ptr<InterferenceHelper::Event> GetEvent (void) const;
    bool operator < (const NiChange& o) const;


private:
    Time m_time; 
    double m_delta; 
    Ptr<InterferenceHelper::Event> m_event; 
  };
  typedef std::vector <NiChange> NiChanges;

  void AppendEvent (Ptr<Event> event);
  double CalculateNoiseInterferenceW (Ptr<Event> event, NiChanges *ni) const;
  double CalculateSnr (double signal, double noiseInterference, uint8_t channelWidth) const;
  double CalculateChunkSuccessRate (double snir, Time duration, WifiMode mode, WifiTxVector txVector) const;
  double CalculatePlcpPayloadPer (Ptr<const Event> event, NiChanges *ni) const;
  double CalculatePlcpHeaderPer (Ptr<const Event> event, NiChanges *ni) const;

  double m_noiseFigure; 
  Ptr<ErrorRateModel> m_errorRateModel; 
  uint8_t m_numRxAntennas; 
  NiChanges m_niChanges;
  double m_firstPower; 
  bool m_rxing; 

  NiChanges::const_iterator GetPosition (Time moment);
  void AddNiChangeEvent (NiChange change);
};

} //namespace ns3

#endif /* INTERFERENCE_HELPER_H */