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 #ifndef ANTENNA_MODEL_H 22 #define ANTENNA_MODEL_H 23 24 25 #include <ns3/object.h> 26 #include <ns3/angles.h> 27 28 namespace ns3 { 29 30 /** 31 * \ingroup antenna 32 * 33 * \brief interface for antenna radiation pattern models 34 * 35 * This class provides an interface for the definition of antenna 36 * radiation pattern models. This interface is based on the use of 37 * spherical coordinates, in particular of the azimuth and inclination 38 * angles. This choice is the one proposed "Antenna Theory - Analysis 39 * and Design", C.A. Balanis, Wiley, 2nd Ed., see in particular 40 * section 2.2 "Radiation pattern". 41 * 42 * 43 */ 44 class AntennaModel : public Object 45 { 46 public: 47 48 49 AntennaModel (); 50 virtual ~AntennaModel (); 51 52 // inherited from Object 53 static TypeId GetTypeId (); 54 55 56 /** 57 * this method is expected to be re-implemented by each antenna model 58 * 59 * \param a the spherical angles at which the radiation pattern should 60 * be evaluated 61 * 62 * \return the power gain in dBi of the antenna radiation pattern at 63 * the specified angles; dBi means dB with respect to the gain of an 64 * isotropic radiator. Since a power gain is used, the efficiency of 65 * the antenna is expected to be included in the gain value. 66 */ 67 virtual double GetGainDb (Angles a) = 0; 68 69 }; 70 71 72 73 } // namespace ns3 74 75 #endif // ANTENNA_MODEL_H 76