A Discrete-Event Network Simulator
API
antenna-model.h
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 #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 
55 class AntennaModel : public Object
56 {
57 public:
58 
59 
60  AntennaModel ();
61  virtual ~AntennaModel ();
62 
67  static TypeId GetTypeId ();
68 
69 
81  virtual double GetGainDb (Angles a) = 0;
82 
83 };
84 
85 
86 
87 } // namespace ns3
88 
89 #endif // ANTENNA_MODEL_H
ns3::Angles
Class holding the azimuth and inclination angles of spherical coordinates.
Definition: angles.h:119
ns3::AntennaModel
interface for antenna radiation pattern models
Definition: antenna-model.h:56
ns3::AntennaModel::~AntennaModel
virtual ~AntennaModel()
Definition: antenna-model.cc:38
ns3::AntennaModel::GetGainDb
virtual double GetGainDb(Angles a)=0
this method is expected to be re-implemented by each antenna model
ns3::AntennaModel::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: antenna-model.cc:43
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.