1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2020 University of Padova, Dep. of Information Engineering, SIGNET lab.
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 
19 #ifndef THREE_GPP_ANTENNA_MODEL_H
20 #define THREE_GPP_ANTENNA_MODEL_H
21 
22 
23 #include <ns3/object.h>
24 #include <ns3/antenna-model.h>
25 
26 namespace ns3 {
27 
28 /**
29  *
30  * \brief  Antenna model based on a parabolic approximation of the main lobe radiation pattern.
31  *
32  * This class implements the parabolic model as described in 3GPP TR 38.901 v15.0.0
33  *
34  */
35 class ThreeGppAntennaModel : public AntennaModel
36 {
37 public:
38   ThreeGppAntennaModel (void);
39   virtual ~ThreeGppAntennaModel (void) override;
40 
41   // inherited from Object
42   static TypeId GetTypeId ();
43 
44   // inherited from AntennaModel
45   virtual double GetGainDb (Angles a) override;
46 
47   /**
48    * Get the vertical beamwidth of the antenna element.
49    * \return the vertical beamwidth in degrees
50    */
51   double GetVerticalBeamwidth () const;
52 
53   /**
54    * Get the horizontal beamwidth of the antenna element.
55    * \return the horizontal beamwidth in degrees
56    */
57   double GetHorizontalBeamwidth () const;
58 
59   /**
60    * Get the side-lobe attenuation in the vertical direction of the antenna element.
61    * \return side-lobe attenuation in the vertical direction in dB
62    */
63   double GetSlaV () const;
64 
65   /**
66    * Get the naximum attenuation of the antenna element.
67    * \return the naximum attenuation in dB
68    */
69   double GetMaxAttenuation () const;
70 
71   /**
72    * Get the maximum directional gain of the antenna element.
73    * \return the maximum directional gain in dBi
74    */
75   double GetAntennaElementGain () const;
76 
77 private:
78   double m_verticalBeamwidthDegrees;    //!< beamwidth in the vertical direction (\theta_{3dB}) [deg]
79   double m_horizontalBeamwidthDegrees;  //!< beamwidth in the horizontal direction (\phi_{3dB}) [deg]
80   double m_aMax;                        //!< maximum attenuation (A_{max}) [dB]
81   double m_slaV;                        //!< side-lobe attenuation in the vertical direction (SLA_V) [dB]
82   double m_geMax;                       //!< maximum directional gain of the antenna element (G_{E,max}) [dBi]
83 };
84 
85 
86 
87 } // namespace ns3
88 
89 
90 #endif // THREE_GPP_ANTENNA_MODEL_H
91