A Discrete-Event Network Simulator
API
yans-wifi-phy.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005,2006 INRIA
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  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18  * Ghada Badawy <gbadawy@gmail.com>
19  * Sébastien Deronne <sebastien.deronne@gmail.com>
20  */
21 
22 #include "yans-wifi-phy.h"
23 
24 #include "interference-helper.h"
25 #include "yans-wifi-channel.h"
26 
27 #include "ns3/log.h"
28 
29 namespace ns3
30 {
31 
32 NS_LOG_COMPONENT_DEFINE("YansWifiPhy");
33 
34 NS_OBJECT_ENSURE_REGISTERED(YansWifiPhy);
35 
36 TypeId
38 {
39  static TypeId tid = TypeId("ns3::YansWifiPhy")
40  .SetParent<WifiPhy>()
41  .SetGroupName("Wifi")
42  .AddConstructor<YansWifiPhy>();
43  return tid;
44 }
45 
47 {
48  NS_LOG_FUNCTION(this);
49 }
50 
51 void
53 {
55  // add dummy band for Yans
56  m_interference->AddBand({{0, 0}, {0, 0}});
57 }
58 
60 {
61  NS_LOG_FUNCTION(this);
62 }
63 
64 void
66 {
67  NS_LOG_FUNCTION(this);
68  m_channel = nullptr;
70 }
71 
74 {
75  return m_channel;
76 }
77 
78 void
80 {
81  NS_LOG_FUNCTION(this << channel);
83  m_channel->Add(this);
84 }
85 
86 void
88 {
89  NS_LOG_FUNCTION(this << ppdu);
90  NS_LOG_DEBUG("Start transmission: signal power before antenna gain="
91  << GetPowerDbm(ppdu->GetTxVector().GetTxPowerLevel()) << "dBm");
92  m_channel->Send(this, ppdu, GetTxPowerForTransmission(ppdu) + GetTxGain());
93 }
94 
95 uint16_t
96 YansWifiPhy::GetGuardBandwidth(uint16_t currentChannelWidth) const
97 {
98  NS_ABORT_MSG("Guard bandwidth not relevant for Yans");
99  return 0;
100 }
101 
102 std::tuple<double, double, double>
104 {
105  NS_ABORT_MSG("Tx mask rejection params not relevant for Yans");
106  return std::make_tuple(0.0, 0.0, 0.0);
107 }
108 
110 YansWifiPhy::GetBand(uint16_t /*bandWidth*/, uint8_t /*bandIndex*/)
111 {
112  return {{0, 0}, {0, 0}};
113 }
114 
117 {
118  return WHOLE_WIFI_SPECTRUM;
119 }
120 
123 {
124  return {0, 0};
125 }
126 
127 } // namespace ns3
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
802.11 PHY layer model
Definition: wifi-phy.h:53
virtual void SetInterferenceHelper(const Ptr< InterferenceHelper > helper)
Sets the interference helper.
Definition: wifi-phy.cc:631
double GetTxGain() const
Return the transmission gain (dB).
Definition: wifi-phy.cc:575
double GetPowerDbm(uint8_t power) const
Get the power of the given power level in dBm.
Definition: wifi-phy.cc:671
void DoDispose() override
Destructor implementation.
Definition: wifi-phy.cc:408
Ptr< InterferenceHelper > m_interference
Pointer to a helper responsible for interference computations.
Definition: wifi-phy.h:1260
double GetTxPowerForTransmission(Ptr< const WifiPpdu > ppdu) const
Compute the transmit power for the next transmission.
Definition: wifi-phy.cc:2184
802.11 PHY layer model
Definition: yans-wifi-phy.h:48
WifiSpectrumBandFrequencies ConvertIndicesToFrequencies(const WifiSpectrumBandIndices &indices) const override
This is a helper function to convert start and stop indices to start and stop frequencies.
Ptr< YansWifiChannel > m_channel
YansWifiChannel that this YansWifiPhy is connected to.
Definition: yans-wifi-phy.h:80
FrequencyRange GetCurrentFrequencyRange() const override
Get the frequency range of the current RF interface.
void StartTx(Ptr< const WifiPpdu > ppdu) override
uint16_t GetGuardBandwidth(uint16_t currentChannelWidth) const override
WifiSpectrumBandInfo GetBand(uint16_t bandWidth, uint8_t bandIndex=0) override
Get the info of a given band.
void SetChannel(const Ptr< YansWifiChannel > channel)
Set the YansWifiChannel this YansWifiPhy is to be connected to.
std::tuple< double, double, double > GetTxMaskRejectionParams() const override
~YansWifiPhy() override
void SetInterferenceHelper(const Ptr< InterferenceHelper > helper) override
Sets the interference helper.
Ptr< Channel > GetChannel() const override
Return the Channel this WifiPhy is connected to.
void DoDispose() override
Destructor implementation.
static TypeId GetTypeId()
Get the type ID.
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
Definition: abort.h:49
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:268
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::pair< uint64_t, uint64_t > WifiSpectrumBandFrequencies
typedef for a pair of start and stop frequencies in Hz to represent a band
constexpr FrequencyRange WHOLE_WIFI_SPECTRUM
Identifier for the frequency range covering the whole wifi spectrum.
std::pair< uint32_t, uint32_t > WifiSpectrumBandIndices
typedef for a pair of start and stop sub-band indices
channel
Definition: third.py:88
Struct defining a frequency range between minFrequency (MHz) and maxFrequency (MHz).
WifiSpectrumBandInfo structure containing info about a spectrum band.