A Discrete-Event Network Simulator
API
jakes-propagation-loss-model.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 Telum (www.telum.ru)
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: Kirill Andreev <andreev@telum.ru>
18  */
19 
21 
22 #include "ns3/double.h"
23 #include "ns3/log.h"
24 
25 namespace ns3
26 {
27 
29 
30 NS_OBJECT_ENSURE_REGISTERED(JakesPropagationLossModel);
31 
33 {
34  m_uniformVariable = CreateObject<UniformRandomVariable>();
35  m_uniformVariable->SetAttribute("Min", DoubleValue(-1.0 * M_PI));
37 }
38 
40 {
41 }
42 
43 TypeId
45 {
46  static TypeId tid = TypeId("ns3::JakesPropagationLossModel")
48  .SetGroupName("Propagation")
49  .AddConstructor<JakesPropagationLossModel>();
50  return tid;
51 }
52 
53 void
55 {
56  m_uniformVariable = nullptr;
57  m_propagationCache.Cleanup();
58 }
59 
60 double
63  Ptr<MobilityModel> b) const
64 {
65  Ptr<JakesProcess> pathData = m_propagationCache.GetPathData(
66  a,
67  b,
68  0 );
69  if (!pathData)
70  {
71  pathData = CreateObject<JakesProcess>();
72  pathData->SetPropagationLossModel(this);
73  m_propagationCache.AddPathData(
74  pathData,
75  a,
76  b,
77  0 );
78  }
79  return txPowerDbm + pathData->GetChannelGainDb();
80 }
81 
84 {
85  return m_uniformVariable;
86 }
87 
88 int64_t
90 {
92  return 1;
93 }
94 
95 } // namespace ns3
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
a Jakes narrowband propagation model.
Ptr< UniformRandomVariable > GetUniformRandomVariable() const
Get the underlying RNG stream.
int64_t DoAssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used by this model.
static TypeId GetTypeId()
Get the type ID.
PropagationCache< JakesProcess > m_propagationCache
Propagation cache.
Ptr< UniformRandomVariable > m_uniformVariable
random stream
double DoCalcRxPower(double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
PropagationLossModel.
void DoDispose() override
Destructor implementation.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:204
Models the propagation loss through a transmission medium.
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
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_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#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.