A Discrete-Event Network Simulator
API
spectrum-wifi-phy.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  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  * Ghada Badawy <gbadawy@gmail.com>
20  * Sébastien Deronne <sebastien.deronne@gmail.com>
21  *
22  * Ported from yans-wifi-phy.h by several contributors starting
23  * with Nicola Baldo and Dean Armstrong
24  */
25 
26 #ifndef SPECTRUM_WIFI_PHY_H
27 #define SPECTRUM_WIFI_PHY_H
28 
29 #include "ns3/antenna-model.h"
30 #include "ns3/spectrum-channel.h"
31 #include "ns3/spectrum-model.h"
32 #include "ns3/wifi-spectrum-value-helper.h"
33 #include "wifi-phy.h"
34 
35 namespace ns3 {
36 
37 class WifiSpectrumPhyInterface;
38 class WifiPpdu;
39 
52 class SpectrumWifiPhy : public WifiPhy
53 {
54 public:
59  static TypeId GetTypeId (void);
60 
61  SpectrumWifiPhy ();
62  virtual ~SpectrumWifiPhy ();
63 
64  // Implementation of pure virtual method.
65  void StartTx (Ptr<WifiPpdu> ppdu);
66  Ptr<Channel> GetChannel (void) const;
67 
74 
81  void StartRx (Ptr<SpectrumSignalParameters> rxParams);
82 
91  uint16_t GetCenterFrequencyForChannelWidth (WifiTxVector txVector) const;
92 
112  void SetAntenna (const Ptr<AntennaModel> antenna);
118  Ptr<AntennaModel> GetRxAntenna (void) const;
125 
129  uint32_t GetBandBandwidth (void) const;
130 
142  uint16_t GetGuardBandwidth (uint16_t currentChannelWidth) const;
143 
152  typedef void (* SignalArrivalCallback) (bool signalType, uint32_t senderNodeId, double rxPower, Time duration);
153 
154  // The following four methods call to the base WifiPhy class method
155  // but also generate a new SpectrumModel if called during runtime
156  virtual void SetChannelNumber (uint8_t id);
157  virtual void SetFrequency (uint16_t freq);
158  virtual void SetChannelWidth (uint16_t channelwidth);
159  virtual void ConfigureStandardAndBand (WifiPhyStandard standard, WifiPhyBand band);
160 
161 
162 
163 protected:
164  // Inherited
165  void DoDispose (void);
166  void DoInitialize (void);
167 
176  WifiSpectrumBand GetBand (uint16_t bandWidth, uint8_t bandIndex = 0);
177 
178 
179 private:
190  Ptr<SpectrumValue> GetTxPowerSpectralDensity (uint16_t centerFrequency, uint16_t channelWidth, double txPowerW, WifiModulationClass modulationClass) const;
191 
199  WifiSpectrumBand ConvertHeRuSubcarriers (uint16_t channelWidth, HeRu::SubcarrierRange range) const;
200 
204  void ResetSpectrumModel (void);
208  void UpdateInterferenceHelperBands (void);
209 
211 
217 
221 };
222 
223 } //namespace ns3
224 
225 #endif /* SPECTRUM_WIFI_PHY_H */
uint16_t GetGuardBandwidth(uint16_t currentChannelWidth) const
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
TracedCallback< bool, uint32_t, double, Time > m_signalCb
Signal callback.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void StartRx(Ptr< SpectrumSignalParameters > rxParams)
Input method for delivering a signal from the spectrum channel and low-level PHY interface to this Sp...
802.11 PHY layer model
Definition: wifi-phy.h:144
Ptr< const SpectrumModel > GetRxSpectrumModel()
Forward calls to a chain of Callback.
static TypeId GetTypeId(void)
Get the type ID.
bool m_disableWifiReception
forces this PHY to fail to sync on any signal
void StartTx(Ptr< WifiPpdu > ppdu)
void SetAntenna(const Ptr< AntennaModel > antenna)
virtual void SetChannelNumber(uint8_t id)
Set channel number.
void(* SignalArrivalCallback)(bool signalType, uint32_t senderNodeId, double rxPower, Time duration)
Callback invoked when the PHY model starts to process a signal.
void DoInitialize(void)
Initialize() implementation.
std::pair< int16_t, int16_t > SubcarrierRange
(lowest index, highest index) pair defining a subcarrier range
Definition: he-ru.h:53
channel
Definition: third.py:92
Ptr< SpectrumChannel > m_channel
SpectrumChannel that this SpectrumWifiPhy is connected to.
WifiSpectrumBand ConvertHeRuSubcarriers(uint16_t channelWidth, HeRu::SubcarrierRange range) const
Ptr< SpectrumValue > GetTxPowerSpectralDensity(uint16_t centerFrequency, uint16_t channelWidth, double txPowerW, WifiModulationClass modulationClass) const
WifiPhyStandard
Identifies the PHY specification that a Wifi device is configured to use.
WifiSpectrumBand GetBand(uint16_t bandWidth, uint8_t bandIndex=0)
Get the start band index and the stop band index for a given band.
double m_txMaskOuterBandMaximumRejection
The maximum rejection (in dBr) for the outer band of the transmit spectrum mask.
double m_txMaskOuterBandMinimumRejection
The minimum rejection (in dBr) for the outer band of the transmit spectrum mask.
void DoDispose(void)
Destructor implementation.
std::pair< uint32_t, uint32_t > WifiSpectrumBand
typedef for a pair of start and stop sub-band indexes
802.11 PHY layer modelThis PHY implements a spectrum-aware enhancement of the 802.11 SpectrumWifiPhy model.
Ptr< const SpectrumModel > m_rxSpectrumModel
receive spectrum model
virtual void SetFrequency(uint16_t freq)
virtual void ConfigureStandardAndBand(WifiPhyStandard standard, WifiPhyBand band)
Configure the PHY-level parameters for different Wi-Fi standard.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint32_t GetBandBandwidth(void) const
virtual void SetChannelWidth(uint16_t channelwidth)
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:30
void UpdateInterferenceHelperBands(void)
This function is called to update the bands handled by the InterferenceHelper.
WifiModulationClass
This enumeration defines the modulation classes per (Table 9-4 "Modulation classes"; IEEE 802...
Definition: wifi-mode.h:38
Ptr< AntennaModel > GetRxAntenna(void) const
Get the antenna model used for reception.
Ptr< AntennaModel > m_antenna
antenna model
uint16_t GetCenterFrequencyForChannelWidth(WifiTxVector txVector) const
Get the center frequency of the channel corresponding the current TxVector rather than that of the su...
Ptr< WifiSpectrumPhyInterface > m_wifiSpectrumPhyInterface
Spectrum PHY interface.
void ResetSpectrumModel(void)
Perform run-time spectrum model change.
double m_txMaskInnerBandMinimumRejection
The minimum rejection (in dBr) for the inner band of the transmit spectrum mask.
Ptr< Channel > GetChannel(void) const
Return the Channel this WifiPhy is connected to.
void SetChannel(const Ptr< SpectrumChannel > channel)
Set the SpectrumChannel this SpectrumWifiPhy is to be connected to.
a unique identifier for an interface.
Definition: type-id.h:58
void CreateWifiSpectrumPhyInterface(Ptr< NetDevice > device)
Method to encapsulate the creation of the WifiSpectrumPhyInterface object (used to bind the WifiSpect...