A Discrete-Event Network Simulator
API
jakes-propagation-loss-model.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2012 Telum (www.telum.ru)
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: Kirill Andreev <andreev@telum.ru>
19  */
20 
22 #include "ns3/double.h"
23 #include "ns3/log.h"
24 
25 namespace ns3
26 {
27 
28 NS_LOG_COMPONENT_DEFINE ("Jakes");
29 
30 NS_OBJECT_ENSURE_REGISTERED (JakesPropagationLossModel);
31 
32 
34 {
35  m_uniformVariable = CreateObject<UniformRandomVariable> ();
36  m_uniformVariable->SetAttribute ("Min", DoubleValue (-1.0 * M_PI));
38 }
39 
41 {}
42 
43 TypeId
45 {
46  static TypeId tid = TypeId ("ns3::JakesPropagationLossModel")
48  .SetGroupName ("Propagation")
49  .AddConstructor<JakesPropagationLossModel> ()
50  ;
51  return tid;
52 }
53 
54 double
57  Ptr<MobilityModel> b) const
58 {
59  Ptr<JakesProcess> pathData = m_propagationCache.GetPathData (a, b, 0 );
60  if (pathData == 0)
61  {
62  pathData = CreateObject<JakesProcess> ();
63  pathData->SetPropagationLossModel (this);
64  m_propagationCache.AddPathData (pathData, a, b, 0 );
65  }
66  return txPowerDbm + pathData->GetChannelGainDb ();
67 }
68 
71 {
72  return m_uniformVariable;
73 }
74 
75 int64_t
77 {
78  m_uniformVariable->SetStream (stream);
79  return 1;
80 }
81 
82 } // namespace ns3
83 
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
static TypeId GetTypeId()
Get the type ID.
double DoCalcRxPower(double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
Returns the Rx Power taking into account only the particular PropagatinLossModel. ...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
PropagationCache< JakesProcess > m_propagationCache
Propagation cache.
Models the propagation loss through a transmission medium.
Ptr< UniformRandomVariable > GetUniformRandomVariable() const
Get the underlying RNG stream.
virtual int64_t DoAssignStreams(int64_t stream)
Subclasses must implement this; those not using random variables can return zero. ...
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
a Jakes narrowband propagation model.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:185
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
Ptr< UniformRandomVariable > m_uniformVariable
random stream