A Discrete-Event Network Simulator
API
cosine-antenna-model.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011 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 
20 #ifndef COSINE_ANTENNA_MODEL_H
21 #define COSINE_ANTENNA_MODEL_H
22 
23 #include "antenna-model.h"
24 
25 #include <ns3/object.h>
26 
27 namespace ns3
28 {
29 
51 {
52  public:
57  static TypeId GetTypeId();
58 
59  // inherited from AntennaModel
60  double GetGainDb(Angles a) override;
61 
66  double GetVerticalBeamwidth() const;
67 
72  double GetHorizontalBeamwidth() const;
73 
78  double GetOrientation() const;
79 
80  private:
85  void SetVerticalBeamwidth(double verticalBeamwidthDegrees);
86 
91  void SetHorizontalBeamwidth(double horizontalBeamwidthDegrees);
92 
97  void SetOrientation(double orientationDegrees);
98 
104  static double GetExponentFromBeamwidth(double beamwidthDegrees);
105 
111  static double GetBeamwidthFromExponent(double exponent);
112 
116  double m_maxGain;
117 };
118 
119 } // namespace ns3
120 
121 #endif // COSINE_ANTENNA_MODEL_H
Class holding the azimuth and inclination angles of spherical coordinates.
Definition: angles.h:118
interface for antenna radiation pattern models
Definition: antenna-model.h:55
Cosine Antenna Model.
double m_maxGain
antenna gain in dB towards the main orientation
void SetHorizontalBeamwidth(double horizontalBeamwidthDegrees)
Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model.
double GetHorizontalBeamwidth() const
Get the horizontal 3 dB beamwidth of the cosine antenna model.
double GetGainDb(Angles a) override
this method is expected to be re-implemented by each antenna model
double GetOrientation() const
Get the horizontal orientation of the antenna element.
static double GetBeamwidthFromExponent(double exponent)
Compute the beamwidth of the cosine antenna model from the exponent.
static double GetExponentFromBeamwidth(double beamwidthDegrees)
Compute the exponent of the cosine antenna model from the beamwidth.
static TypeId GetTypeId()
Get the type ID.
double GetVerticalBeamwidth() const
Get the vertical 3 dB beamwidth of the cosine antenna model.
double m_verticalExponent
exponent of the vertical direction
void SetVerticalBeamwidth(double verticalBeamwidthDegrees)
Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model.
void SetOrientation(double orientationDegrees)
Set the horizontal orientation of the antenna element.
double m_orientationRadians
orientation in radians in the horizontal direction (bearing)
double m_horizontalExponent
exponent of the horizontal direction
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.