spectrum-wifi-phy.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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Ghada Badawy <gbadawy@gmail.com>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 *
 * Ported from yans-wifi-phy.h by several contributors starting
 * with Nicola Baldo and Dean Armstrong
 */
 
#ifndef SPECTRUM_WIFI_PHY_H
#define SPECTRUM_WIFI_PHY_H
 
#include "ns3/antenna-model.h"
#include "ns3/spectrum-channel.h"
#include "ns3/spectrum-model.h"
#include "wifi-phy.h"
#include <map>
 
class SpectrumWifiPhyFilterTest;
 
namespace ns3 {
 
class WifiSpectrumPhyInterface;
struct WifiSpectrumSignalParameters;
 
class SpectrumWifiPhy : public WifiPhy
{
public:
  friend class ::SpectrumWifiPhyFilterTest;
 
  static TypeId GetTypeId (void);
 
  SpectrumWifiPhy ();
  virtual ~SpectrumWifiPhy ();
 
  // Implementation of pure virtual method.
  void StartTx (Ptr<WifiPpdu> ppdu) override;
  Ptr<Channel> GetChannel (void) const override;
  uint16_t GetGuardBandwidth (uint16_t currentChannelWidth) const override;
  std::tuple<double, double, double> GetTxMaskRejectionParams (void) const override;
 
  void SetChannel (const Ptr<SpectrumChannel> channel);
 
  void StartRx (Ptr<SpectrumSignalParameters> rxParams);
 
  void CreateWifiSpectrumPhyInterface (Ptr<NetDevice> device);
  void SetAntenna (const Ptr<AntennaModel> antenna);
  Ptr<AntennaModel> GetRxAntenna (void) const;
  Ptr<const SpectrumModel> GetRxSpectrumModel ();
 
  uint32_t GetBandBandwidth (void) const;
 
  typedef void (* SignalArrivalCallback) (bool signalType, uint32_t senderNodeId, double rxPower, Time duration);
 
  // The following four methods call to the base WifiPhy class method
  // but also generate a new SpectrumModel if called during runtime
  void SetChannelNumber (uint8_t id) override;
  void SetFrequency (uint16_t freq) override;
  void SetChannelWidth (uint16_t channelwidth) override;
  void ConfigureStandardAndBand (WifiPhyStandard standard, WifiPhyBand band) override;
 
  void Transmit (Ptr<WifiSpectrumSignalParameters> txParams);
 
protected:
  void DoDispose (void) override;
  void DoInitialize (void) override;
 
  WifiSpectrumBand GetBand (uint16_t bandWidth, uint8_t bandIndex = 0) override;
 
private:
  WifiSpectrumBand ConvertHeRuSubcarriers (uint16_t bandWidth, uint16_t guardBandwidth,
                                           HeRu::SubcarrierRange range, uint8_t bandIndex = 0) const override;
 
  void ResetSpectrumModel (void);
  void UpdateInterferenceHelperBands (void);
 
  Ptr<SpectrumChannel> m_channel; 
 
  Ptr<WifiSpectrumPhyInterface> m_wifiSpectrumPhyInterface; 
  Ptr<AntennaModel> m_antenna;                              
  mutable Ptr<const SpectrumModel> m_rxSpectrumModel;       
 
  typedef std::map<WifiSpectrumBand, HeRu::RuSpec> RuBand;
 
  std::map<uint16_t, RuBand> m_ruBands;  
  bool m_disableWifiReception;                              
  TracedCallback<bool, uint32_t, double, Time> m_signalCb;  
 
  double m_txMaskInnerBandMinimumRejection; 
  double m_txMaskOuterBandMinimumRejection; 
  double m_txMaskOuterBandMaximumRejection; 
};
 
} //namespace ns3
 
#endif /* SPECTRUM_WIFI_PHY_H */