A Discrete-Event Network Simulator
API
isotropic-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 
25 #include "antenna-model.h"
27 
28 
29 
30 namespace ns3 {
31 
32 NS_LOG_COMPONENT_DEFINE ("IsotropicAntennaModel");
33 
34 NS_OBJECT_ENSURE_REGISTERED (IsotropicAntennaModel);
35 
36 
37 TypeId
39 {
40  static TypeId tid = TypeId ("ns3::IsotropicAntennaModel")
42  .SetGroupName("Antenna")
43  .AddConstructor<IsotropicAntennaModel> ()
44  .AddAttribute ("Gain",
45  "The gain of the antenna in dB",
46  DoubleValue (0),
48  MakeDoubleChecker<double> ())
49  ;
50  return tid;
51 }
52 
54 {
55  NS_LOG_FUNCTION (this);
56 }
57 
58 double
60 {
61  NS_LOG_FUNCTION (this << a);
62  return m_gainDb;
63 }
64 
65 }
66 
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
NS_OBJECT_ENSURE_REGISTERED
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::IsotropicAntennaModel::m_gainDb
double m_gainDb
gain of the antenna in dB, in all directions
Definition: isotropic-antenna-model.h:52
ns3::IsotropicAntennaModel
Isotropic antenna model.
Definition: isotropic-antenna-model.h:36
antenna-model.h
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
ns3::DoubleValue
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
ns3::IsotropicAntennaModel::IsotropicAntennaModel
IsotropicAntennaModel()
Definition: isotropic-antenna-model.cc:53
ns3::AntennaModel
interface for antenna radiation pattern models
Definition: antenna-model.h:45
ns3::IsotropicAntennaModel::GetGainDb
virtual double GetGainDb(Angles a)
this method is expected to be re-implemented by each antenna model
Definition: isotropic-antenna-model.cc:59
isotropic-antenna-model.h
ns3::MakeDoubleAccessor
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
ns3::Angles
Class holding the azimuth and inclination angles of spherical coordinates.
Definition: angles.h:119
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:244
ns3::IsotropicAntennaModel::GetTypeId
static TypeId GetTypeId()
Definition: isotropic-antenna-model.cc:38