A Discrete-Event Network Simulator
API
single-model-spectrum-channel.cc
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 
21 
22 #include "spectrum-phy.h"
25 
26 #include <ns3/angles.h>
27 #include <ns3/antenna-model.h>
28 #include <ns3/double.h>
29 #include <ns3/log.h>
30 #include <ns3/mobility-model.h>
31 #include <ns3/net-device.h>
32 #include <ns3/node.h>
33 #include <ns3/object.h>
34 #include <ns3/packet-burst.h>
35 #include <ns3/packet.h>
36 #include <ns3/propagation-delay-model.h>
37 #include <ns3/propagation-loss-model.h>
38 #include <ns3/simulator.h>
39 
40 #include <algorithm>
41 
42 namespace ns3
43 {
44 
45 NS_LOG_COMPONENT_DEFINE("SingleModelSpectrumChannel");
46 
47 NS_OBJECT_ENSURE_REGISTERED(SingleModelSpectrumChannel);
48 
50 {
51  NS_LOG_FUNCTION(this);
52 }
53 
54 void
56 {
57  NS_LOG_FUNCTION(this);
58  m_phyList.clear();
59  m_spectrumModel = nullptr;
61 }
62 
63 TypeId
65 {
67  static TypeId tid = TypeId("ns3::SingleModelSpectrumChannel")
69  .SetGroupName("Spectrum")
70  .AddConstructor<SingleModelSpectrumChannel>();
71  return tid;
72 }
73 
74 void
76 {
77  NS_LOG_FUNCTION(this << phy);
78  auto it = std::find(begin(m_phyList), end(m_phyList), phy);
79  if (it != std::end(m_phyList))
80  {
81  m_phyList.erase(it);
82  }
83 }
84 
85 void
87 {
88  NS_LOG_FUNCTION(this << phy);
89  if (std::find(m_phyList.cbegin(), m_phyList.cend(), phy) == m_phyList.cend())
90  {
91  m_phyList.push_back(phy);
92  }
93 }
94 
95 void
97 {
98  NS_LOG_FUNCTION(this << txParams->psd << txParams->duration << txParams->txPhy);
99  NS_ASSERT_MSG(txParams->psd, "NULL txPsd");
100  NS_ASSERT_MSG(txParams->txPhy, "NULL txPhy");
101 
102  Ptr<SpectrumSignalParameters> txParamsTrace =
103  txParams->Copy(); // copy it since traced value cannot be const (because of potential
104  // underlying DynamicCasts)
105  m_txSigParamsTrace(txParamsTrace);
106 
107  // just a sanity check routine. We might want to remove it to save some computational load --
108  // one "if" statement ;-)
109  if (!m_spectrumModel)
110  {
111  // first pak, record SpectrumModel
112  m_spectrumModel = txParams->psd->GetSpectrumModel();
113  }
114  else
115  {
116  // all attached SpectrumPhy instances must use the same SpectrumModel
117  NS_ASSERT(*(txParams->psd->GetSpectrumModel()) == *m_spectrumModel);
118  }
119 
120  Ptr<MobilityModel> senderMobility = txParams->txPhy->GetMobility();
121 
122  for (auto rxPhyIterator = m_phyList.begin(); rxPhyIterator != m_phyList.end(); ++rxPhyIterator)
123  {
124  Ptr<NetDevice> rxNetDevice = (*rxPhyIterator)->GetDevice();
125  Ptr<NetDevice> txNetDevice = txParams->txPhy->GetDevice();
126 
127  if (rxNetDevice && txNetDevice)
128  {
129  // we assume that devices are attached to a node
130  if (rxNetDevice->GetNode()->GetId() == txNetDevice->GetNode()->GetId())
131  {
132  NS_LOG_DEBUG("Skipping the pathloss calculation among different antennas of the "
133  "same node, not supported yet by any pathloss model in ns-3.");
134  continue;
135  }
136  }
137 
138  if (m_filter && m_filter->Filter(txParams, *rxPhyIterator))
139  {
140  continue;
141  }
142 
143  if ((*rxPhyIterator) != txParams->txPhy)
144  {
145  Time delay = MicroSeconds(0);
146 
147  Ptr<MobilityModel> receiverMobility = (*rxPhyIterator)->GetMobility();
148  NS_LOG_LOGIC("copying signal parameters " << txParams);
149  Ptr<SpectrumSignalParameters> rxParams = txParams->Copy();
150 
151  if (senderMobility && receiverMobility)
152  {
153  double txAntennaGain = 0;
154  double rxAntennaGain = 0;
155  double propagationGainDb = 0;
156  double pathLossDb = 0;
157  if (rxParams->txAntenna)
158  {
159  Angles txAngles(receiverMobility->GetPosition(), senderMobility->GetPosition());
160  txAntennaGain = rxParams->txAntenna->GetGainDb(txAngles);
161  NS_LOG_LOGIC("txAntennaGain = " << txAntennaGain << " dB");
162  pathLossDb -= txAntennaGain;
163  }
164  Ptr<AntennaModel> rxAntenna =
165  DynamicCast<AntennaModel>((*rxPhyIterator)->GetAntenna());
166  if (rxAntenna)
167  {
168  Angles rxAngles(senderMobility->GetPosition(), receiverMobility->GetPosition());
169  rxAntennaGain = rxAntenna->GetGainDb(rxAngles);
170  NS_LOG_LOGIC("rxAntennaGain = " << rxAntennaGain << " dB");
171  pathLossDb -= rxAntennaGain;
172  }
173  if (m_propagationLoss)
174  {
175  propagationGainDb =
176  m_propagationLoss->CalcRxPower(0, senderMobility, receiverMobility);
177  NS_LOG_LOGIC("propagationGainDb = " << propagationGainDb << " dB");
178  pathLossDb -= propagationGainDb;
179  }
180  NS_LOG_LOGIC("total pathLoss = " << pathLossDb << " dB");
181  // Gain trace
182  m_gainTrace(senderMobility,
183  receiverMobility,
184  txAntennaGain,
185  rxAntennaGain,
186  propagationGainDb,
187  pathLossDb);
188  // Pathloss trace
189  m_pathLossTrace(txParams->txPhy, *rxPhyIterator, pathLossDb);
190  if (pathLossDb > m_maxLossDb)
191  {
192  // beyond range
193  continue;
194  }
195  double pathGainLinear = std::pow(10.0, (-pathLossDb) / 10.0);
196  *(rxParams->psd) *= pathGainLinear;
197 
198  if (m_propagationDelay)
199  {
200  delay = m_propagationDelay->GetDelay(senderMobility, receiverMobility);
201  }
202  }
203 
204  if (rxNetDevice)
205  {
206  // the receiver has a NetDevice, so we expect that it is attached to a Node
207  uint32_t dstNode = rxNetDevice->GetNode()->GetId();
209  delay,
211  this,
212  rxParams,
213  *rxPhyIterator);
214  }
215  else
216  {
217  // the receiver is not attached to a NetDevice, so we cannot assume that it is
218  // attached to a node
219  Simulator::Schedule(delay,
221  this,
222  rxParams,
223  *rxPhyIterator);
224  }
225  }
226  }
227 }
228 
229 void
231 {
232  NS_LOG_FUNCTION(this << params);
234  {
235  params->psd =
236  m_spectrumPropagationLoss->CalcRxPowerSpectralDensity(params,
237  params->txPhy->GetMobility(),
238  receiver->GetMobility());
239  }
240  receiver->StartRx(params);
241 }
242 
243 std::size_t
245 {
246  NS_LOG_FUNCTION(this);
247  return m_phyList.size();
248 }
249 
252 {
253  NS_LOG_FUNCTION(this << i);
254  return m_phyList.at(i)->GetDevice()->GetObject<NetDevice>();
255 }
256 
257 } // namespace ns3
Class holding the azimuth and inclination angles of spherical coordinates.
Definition: angles.h:118
virtual double GetGainDb(Angles a)=0
this method is expected to be re-implemented by each antenna model
Vector GetPosition() const
Network layer to device interface.
Definition: net-device.h:98
double CalcRxPower(double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:571
static void ScheduleWithContext(uint32_t context, const Time &delay, FUNC f, Ts &&... args)
Schedule an event with the given context.
Definition: simulator.h:588
SpectrumChannel implementation which handles a single spectrum model.
Ptr< const SpectrumModel > m_spectrumModel
SpectrumModel that this channel instance is supporting.
PhyList m_phyList
List of SpectrumPhy instances attached to the channel.
void StartTx(Ptr< SpectrumSignalParameters > params) override
Used by attached PHY instances to transmit signals on the channel.
void DoDispose() override
Destructor implementation.
void RemoveRx(Ptr< SpectrumPhy > phy) override
Remove a SpectrumPhy from a channel.
void AddRx(Ptr< SpectrumPhy > phy) override
Add a SpectrumPhy to a channel, so it can receive packets.
Ptr< NetDevice > GetDevice(std::size_t i) const override
void StartRx(Ptr< SpectrumSignalParameters > params, Ptr< SpectrumPhy > receiver)
Used internally to reschedule transmission after the propagation delay.
static TypeId GetTypeId()
Get the type ID.
Defines the interface for spectrum-aware channel implementations.
TracedCallback< Ptr< SpectrumSignalParameters > > m_txSigParamsTrace
Traced callback for SpectrumSignalParameters in StartTx requests.
void DoDispose() override
Destructor implementation.
Ptr< SpectrumTransmitFilter > m_filter
Transmit filter to be used with this channel.
Ptr< PropagationDelayModel > m_propagationDelay
Propagation delay model to be used with this channel.
Ptr< SpectrumPropagationLossModel > m_spectrumPropagationLoss
Frequency-dependent propagation loss model to be used with this channel.
TracedCallback< Ptr< const SpectrumPhy >, Ptr< const SpectrumPhy >, double > m_pathLossTrace
The PathLoss trace source.
TracedCallback< Ptr< const MobilityModel >, Ptr< const MobilityModel >, double, double, double, double > m_gainTrace
The Gain trace source.
Ptr< PropagationLossModel > m_propagationLoss
Single-frequency propagation loss model to be used with this channel.
double m_maxLossDb
Maximum loss [dB].
virtual void StartRx(Ptr< SpectrumSignalParameters > params)=0
Notify the SpectrumPhy instance of an incoming signal.
virtual Ptr< MobilityModel > GetMobility() const =0
Get the associated MobilityModel instance.
virtual Ptr< NetDevice > GetDevice() const =0
Get the associated NetDevice instance.
Ptr< const SpectrumModel > GetSpectrumModel() const
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition: assert.h:66
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:86
#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_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:282
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
#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
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1350
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:89
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
Ptr< AntennaModel > txAntenna
The AntennaModel instance that was used to transmit this signal.
Time duration
The duration of the packet transmission.
Ptr< SpectrumPhy > txPhy
The SpectrumPhy instance that is making the transmission.
virtual Ptr< SpectrumSignalParameters > Copy() const
make a "virtual" copy of this class, where "virtual" refers to the fact that if the actual object is ...
Ptr< SpectrumValue > psd
The Power Spectral Density of the waveform, in linear units.