A Discrete-Event Network Simulator
API
spectrum-analyzer.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 CTTC
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  * Author: Nicola Baldo <nbaldo@cttc.es>
19  */
20 
21 
22 #include <ns3/object-factory.h>
23 #include <ns3/log.h>
24 #include <ns3/double.h>
25 #include <ns3/simulator.h>
26 #include <ns3/trace-source-accessor.h>
27 #include <ns3/antenna-model.h>
28 
29 #include "spectrum-analyzer.h"
30 
31 namespace ns3 {
32 
33 NS_LOG_COMPONENT_DEFINE ("SpectrumAnalyzer");
34 
35 NS_OBJECT_ENSURE_REGISTERED (SpectrumAnalyzer);
36 
38  : m_mobility (0),
39  m_netDevice (0),
40  m_channel (0),
41  m_spectrumModel (0),
42  m_sumPowerSpectralDensity (0),
43  m_resolution (MilliSeconds (50)),
44  m_active (false)
45 {
46  NS_LOG_FUNCTION (this);
47 }
48 
49 
50 
52 {
53  NS_LOG_FUNCTION (this);
54 }
55 
56 void
58 {
59  NS_LOG_FUNCTION (this);
60  m_mobility = 0;
61  m_netDevice = 0;
62  m_channel = 0;
63  m_spectrumModel = 0;
67 }
68 
69 TypeId
71 {
72  static TypeId tid = TypeId ("ns3::SpectrumAnalyzer")
74  .SetGroupName ("Spectrum")
75  .AddConstructor<SpectrumAnalyzer> ()
76  .AddAttribute ("Resolution",
77  "The length of the time interval over which the "
78  "power spectral density of incoming signals is averaged",
79  TimeValue (MilliSeconds (1)),
81  MakeTimeChecker ())
82  .AddAttribute ("NoisePowerSpectralDensity",
83  "The power spectral density of the measuring instrument "
84  "noise, in Watt/Hz. Mostly useful to make spectrograms "
85  "look more similar to those obtained by real devices. "
86  "Defaults to the value for thermal noise at 300K.",
87  DoubleValue (1.38e-23 * 300),
89  MakeDoubleChecker<double> ())
90  .AddTraceSource ("AveragePowerSpectralDensityReport",
91  "Trace fired whenever a new value for the average "
92  "Power Spectral Density is calculated",
94  "ns3::SpectrumValue::TracedCallback")
95  ;
96  return tid;
97 }
98 
99 
100 
103 {
104  return m_netDevice;
105 }
106 
107 
110 {
111  return m_mobility;
112 }
113 
114 
117 {
118  return m_spectrumModel;
119 }
120 
121 void
123 {
124  NS_LOG_FUNCTION (this << d);
125  m_netDevice = d;
126 }
127 
128 
129 void
131 {
132  NS_LOG_FUNCTION (this << m);
133  m_mobility = m;
134 }
135 
136 
137 void
139 {
140  NS_LOG_FUNCTION (this << c);
141  m_channel = c;
142 }
143 
144 
147 {
148  return m_antenna;
149 }
150 
151 void
153 {
154  NS_LOG_FUNCTION (this << a);
155  m_antenna = a;
156 }
157 
158 
159 
160 void
162 {
163  NS_LOG_FUNCTION ( this << params);
164  AddSignal (params->psd);
165  Simulator::Schedule (params->duration, &SpectrumAnalyzer::SubtractSignal, this, params->psd);
166 }
167 
168 
169 void
171 {
172  NS_LOG_FUNCTION (this << *psd);
174  (*m_sumPowerSpectralDensity) += (*psd);
175 }
176 
177 void
179 {
180  NS_LOG_FUNCTION (this << *psd);
182  (*m_sumPowerSpectralDensity) -= (*psd);
183 }
184 
185 void
187 {
188  NS_LOG_FUNCTION (this);
189  if (m_lastChangeTime < Now ())
190  {
191  (*m_energySpectralDensity) += (*m_sumPowerSpectralDensity) * ((Now () - m_lastChangeTime).GetSeconds ());
192  m_lastChangeTime = Now ();
193  }
194  else
195  {
197  }
198 }
199 
200 void
202 {
203  NS_LOG_FUNCTION (this);
204 
206  Ptr<SpectrumValue> avgPowerSpectralDensity = Create<SpectrumValue> (m_sumPowerSpectralDensity->GetSpectrumModel ());
207  (*avgPowerSpectralDensity) = (*m_energySpectralDensity) / m_resolution.GetSeconds ();
208  (*avgPowerSpectralDensity) += m_noisePowerSpectralDensity;
209  (*m_energySpectralDensity) = 0;
210 
211  NS_LOG_INFO ("generating report");
212  m_averagePowerSpectralDensityReportTrace (avgPowerSpectralDensity);
213 
214  *avgPowerSpectralDensity = 0;
215 
216  if (m_active)
217  {
219  }
220 }
221 
222 
223 
224 void
226 {
227  NS_LOG_FUNCTION (this << f);
228  m_spectrumModel = f;
230  m_sumPowerSpectralDensity = Create<SpectrumValue> (f);
231  m_energySpectralDensity = Create<SpectrumValue> (f);
233 }
234 
235 
236 
237 
238 void
240 {
241  NS_LOG_FUNCTION (this);
242  if (!m_active)
243  {
244  NS_LOG_LOGIC ("activating");
245  m_active = true;
247  }
248 }
249 
250 
251 void
253 {
254  m_active = false;
255 }
256 
257 } // namespace ns3
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Abstract base class for Spectrum-aware PHY layers.
Definition: spectrum-phy.h:45
Ptr< NetDevice > m_netDevice
Pointer to the NetDevice using this object.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
void StartRx(Ptr< SpectrumSignalParameters > params)
Notify the SpectrumPhy instance of an incoming signal.
double m_noisePowerSpectralDensity
Noise power spectral density.
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:361
Ptr< AntennaModel > m_antenna
Pointer to the Antenna model.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1078
virtual void Start()
Start the spectrum analyzer.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
virtual void DoDispose(void)
Destructor implementation.
Definition: object.cc:346
void SetChannel(Ptr< SpectrumChannel > c)
Set the channel attached to this device.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:449
bool m_active
True if the analyzer is active.
Ptr< NetDevice > GetDevice() const
Get the associated NetDevice instance.
Ptr< SpectrumChannel > m_channel
Pointer to the channel to be analyzed.
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1390
AttributeValue implementation for Time.
Definition: nstime.h:1132
static TypeId GetTypeId(void)
Get the type ID.
virtual void Stop()
Stop the spectrum analyzer.
void SetRxSpectrumModel(Ptr< SpectrumModel > m)
Set the spectrum model used by the SpectrumAnalyzer to represent incoming signals.
void DoDispose()
Destructor implementation.
double f(double x, void *params)
Definition: 80211b.c:70
void SetDevice(Ptr< NetDevice > d)
Set the associated NetDevice instance.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Simple SpectrumPhy implementation that averages the spectrum power density of incoming transmissions ...
void AddSignal(Ptr< const SpectrumValue > psd)
Adds a signal to the data collected.
Ptr< const SpectrumModel > GetSpectrumModel() const
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: nstime.h:1133
TracedCallback< Ptr< const SpectrumValue > > m_averagePowerSpectralDensityReportTrace
TracedCallback - average power spectral density report.
NS_LOG_LOGIC("Net device "<< nd<< " is not bridged")
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: double.h:42
Ptr< SpectrumValue > m_sumPowerSpectralDensity
Sum of the received PSD.
Ptr< SpectrumModel > m_spectrumModel
Spectrum model.
Ptr< const SpectrumModel > GetRxSpectrumModel() const
Ptr< MobilityModel > GetMobility()
Get the associated MobilityModel instance.
virtual void GenerateReport()
Generates a report of the data collected so far.
void SetMobility(Ptr< MobilityModel > m)
Set the mobility model associated with this device.
Time Now(void)
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:309
Ptr< AntennaModel > GetRxAntenna()
Get the AntennaModel used by the NetDevice for reception.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
void SubtractSignal(Ptr< const SpectrumValue > psd)
Removes a signal to the data collected.
a unique identifier for an interface.
Definition: type-id.h:58
Time m_lastChangeTime
When the last update happened.
Ptr< MobilityModel > m_mobility
Pointer to the mobility model.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:923
Ptr< SpectrumValue > m_energySpectralDensity
Energy spectral density.
void SetAntenna(Ptr< AntennaModel > a)
Set the AntennaModel to be used.
void UpdateEnergyReceivedSoFar()
Updates the data about the received Energy.
Time m_resolution
Time resolution.