A Discrete-Event Network Simulator
API
cosine-antenna-model.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 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/log.h>
23 #include <ns3/double.h>
24 #include <cmath>
25 
26 #include "antenna-model.h"
27 #include "cosine-antenna-model.h"
28 
29 
30 namespace ns3 {
31 
32 NS_LOG_COMPONENT_DEFINE ("CosineAntennaModel");
33 
34 NS_OBJECT_ENSURE_REGISTERED (CosineAntennaModel);
35 
36 
37 TypeId
39 {
40  static TypeId tid = TypeId ("ns3::CosineAntennaModel")
42  .SetGroupName("Antenna")
43  .AddConstructor<CosineAntennaModel> ()
44  .AddAttribute ("Beamwidth",
45  "The 3dB beamwidth (degrees)",
46  DoubleValue (60),
49  MakeDoubleChecker<double> (0, 180))
50  .AddAttribute ("Orientation",
51  "The angle (degrees) that expresses the orientation of the antenna on the x-y plane relative to the x axis",
52  DoubleValue (0.0),
55  MakeDoubleChecker<double> (-360, 360))
56  .AddAttribute ("MaxGain",
57  "The gain (dB) at the antenna boresight (the direction of maximum gain)",
58  DoubleValue (0.0),
60  MakeDoubleChecker<double> ())
61  ;
62  return tid;
63 }
64 
65 void
66 CosineAntennaModel::SetBeamwidth (double beamwidthDegrees)
67 {
68  NS_LOG_FUNCTION (this << beamwidthDegrees);
69  m_beamwidthRadians = DegreesToRadians (beamwidthDegrees);
70  m_exponent = -3.0 / (20 * std::log10 (std::cos (m_beamwidthRadians / 4.0)));
71  NS_LOG_LOGIC (this << " m_exponent = " << m_exponent);
72 }
73 
74 double
76 {
78 }
79 
80 void
81 CosineAntennaModel::SetOrientation (double orientationDegrees)
82 {
83  NS_LOG_FUNCTION (this << orientationDegrees);
84  m_orientationRadians = DegreesToRadians (orientationDegrees);
85 }
86 
87 double
89 {
91 }
92 
93 double
95 {
96  NS_LOG_FUNCTION (this << a);
97  // azimuth angle w.r.t. the reference system of the antenna
98  double phi = a.phi - m_orientationRadians;
99 
100  // make sure phi is in (-pi, pi]
101  while (phi <= -M_PI)
102  {
103  phi += M_PI+M_PI;
104  }
105  while (phi > M_PI)
106  {
107  phi -= M_PI+M_PI;
108  }
109 
110  NS_LOG_LOGIC ("phi = " << phi );
111 
112  // element factor: amplitude gain of a single antenna element in linear units
113  double ef = std::pow (std::cos (phi / 2.0), m_exponent);
114 
115  // the array factor is not considered. Note that if we did consider
116  // the array factor, the actual beamwidth would change, and in
117  // particular it would be different from the one specified by the
118  // user. Hence it is not desirable to use the array factor, for the
119  // ease of use of this model.
120 
121  double gainDb = 20 * std::log10 (ef);
122  NS_LOG_LOGIC ("gain = " << gainDb << " + " << m_maxGain << " dB");
123  return gainDb + m_maxGain;
124 }
125 
126 
127 }
128 
virtual double GetGainDb(Angles a)
this method is expected to be re-implemented by each antenna model
#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:45
double DegreesToRadians(double degrees)
converts degrees to radians
Definition: angles.cc:31
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:204
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Cosine Antenna Model.
void SetOrientation(double orientationDegrees)
NS_LOG_LOGIC("Net device "<< nd<< " is not bridged")
double RadiansToDegrees(double radians)
converts radians to degrees
Definition: angles.cc:37
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
double m_exponent
this is the variable "n" in the paper by Chunjian
double phi
the azimuth angle in radians
Definition: angles.h:111
struct holding the azimuth and inclination angles of spherical coordinates.
Definition: angles.h:71
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
interface for antenna radiation pattern models
Definition: antenna-model.h:44
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
void SetBeamwidth(double beamwidthDegrees)