A Discrete-Event Network Simulator
API
wifi-spectrum-phy-interface.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009 CTTC
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Nicola Baldo <nbaldo@cttc.es>
18  */
19 
20 #ifndef WIFI_SPECTRUM_PHY_INTERFACE_H
21 #define WIFI_SPECTRUM_PHY_INTERFACE_H
22 
23 #include "spectrum-wifi-phy.h"
24 
25 #include "ns3/he-phy.h"
26 #include "ns3/spectrum-phy.h"
27 
28 namespace ns3
29 {
30 
31 class SpectrumWifiPhy;
32 
45 {
46  public:
51  static TypeId GetTypeId();
63 
69 
70  Ptr<NetDevice> GetDevice() const override;
71  void SetDevice(const Ptr<NetDevice> d) override;
72  void SetMobility(const Ptr<MobilityModel> m) override;
73  Ptr<MobilityModel> GetMobility() const override;
74  void SetChannel(const Ptr<SpectrumChannel> c) override;
76  Ptr<Object> GetAntenna() const override;
78 
85 
91  const FrequencyRange& GetFrequencyRange() const;
92 
99  uint16_t GetCenterFrequency() const;
100 
107  uint16_t GetChannelWidth() const;
108 
115 
124  void SetRxSpectrumModel(uint32_t centerFrequency,
125  uint16_t channelWidth,
126  uint32_t bandBandwidth,
127  uint16_t guardBandwidth);
128 
134  void SetBands(WifiSpectrumBands&& bands);
140  const WifiSpectrumBands& GetBands() const;
141 
147  void SetHeRuBands(HeRuBands&& heRuBands);
153  const HeRuBands& GetHeRuBands() const;
154 
155  private:
156  void DoDispose() override;
157 
162  uint16_t m_centerFrequency;
163  uint16_t m_channelWidth;
165 
169 };
170 
171 } // namespace ns3
172 
173 #endif /* WIFI_SPECTRUM_PHY_INTERFACE_H */
Abstract base class for Spectrum-aware PHY layers.
Definition: spectrum-phy.h:46
a unique identifier for an interface.
Definition: type-id.h:59
This class is an adaptor between class SpectrumWifiPhy (which inherits from WifiPhy) and class Spectr...
void SetDevice(const Ptr< NetDevice > d) override
Set the associated NetDevice instance.
const HeRuBands & GetHeRuBands() const
Get the HE RU spectrum bands handled by this interface.
void StartTx(Ptr< SpectrumSignalParameters > params)
Start transmission over the spectrum channel.
const FrequencyRange & GetFrequencyRange() const
Get the frequency range covered by the spectrum channel this interface is attached to.
Ptr< const SpectrumModel > m_rxSpectrumModel
receive spectrum model
uint16_t m_centerFrequency
center frequency in MHz
HeRuBands m_heRuBands
Store all the distinct spectrum bands associated with every RU.
uint16_t m_channelWidth
channel width in MHz
Ptr< Object > GetAntenna() const override
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.
FrequencyRange m_frequencyRange
frequency range
void SetSpectrumWifiPhy(const Ptr< SpectrumWifiPhy > phy)
Connect SpectrumWifiPhy object.
const WifiSpectrumBands & GetBands() const
Get the vector of spectrum bands handled by this interface.
void SetRxSpectrumModel(uint32_t centerFrequency, uint16_t channelWidth, uint32_t bandBandwidth, uint16_t guardBandwidth)
Set the RX spectrum model.
Ptr< NetDevice > m_netDevice
the device
void SetChannel(const Ptr< SpectrumChannel > c) override
Set the channel attached to this device.
void DoDispose() override
Destructor implementation.
void StartRx(Ptr< SpectrumSignalParameters > params) override
Notify the SpectrumPhy instance of an incoming signal.
uint16_t GetCenterFrequency() const
Get the center frequency in MHz of the the spectrum channel this interface is attached to.
Ptr< const SpectrumModel > GetRxSpectrumModel() const override
void SetHeRuBands(HeRuBands &&heRuBands)
Set the HE RU spectrum bands handled by this interface (if any)
void SetMobility(const Ptr< MobilityModel > m) override
Set the mobility model associated with this device.
Ptr< NetDevice > GetDevice() const override
Get the associated NetDevice instance.
WifiSpectrumBands m_bands
Store all the distinct spectrum bands associated with every channels widths.
WifiSpectrumPhyInterface(FrequencyRange freqRange)
Constructor.
Ptr< MobilityModel > GetMobility() const override
Get the associated MobilityModel instance.
void SetBands(WifiSpectrumBands &&bands)
Set the vector of spectrum bands handled by this interface.
uint16_t GetChannelWidth() const
Get the channel width in MHz covered by the spectrum channel this interface is attached to.
static TypeId GetTypeId()
Get the type ID.
Ptr< SpectrumChannel > m_channel
spectrum channel
Ptr< SpectrumChannel > GetChannel() const
Get the spectrum channel this interface is attached to.
Ptr< SpectrumWifiPhy > m_spectrumWifiPhy
spectrum PHY
Ptr< const SpectrumWifiPhy > GetSpectrumWifiPhy() const
Get SpectrumWifiPhy object.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< WifiSpectrumBandInfo > WifiSpectrumBands
vector of spectrum bands
std::map< WifiSpectrumBandInfo, HeRu::RuSpec > HeRuBands
Map a spectrum band associated with an RU to the RU specification.
phy
Definition: third.py:89
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
Struct defining a frequency range between minFrequency (MHz) and maxFrequency (MHz).