A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
cosine-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 COSINE_ANTENNA_MODEL_H
22
#define COSINE_ANTENNA_MODEL_H
23
24
25
#include <ns3/object.h>
26
#include <ns3/antenna-model.h>
27
28
namespace
ns3
{
29
50
class
CosineAntennaModel
:
public
AntennaModel
51
{
52
public
:
57
static
TypeId
GetTypeId
();
58
59
// inherited from AntennaModel
60
virtual
double
GetGainDb
(
Angles
a);
61
66
double
GetVerticalBeamwidth
(
void
)
const
;
67
72
double
GetHorizontalBeamwidth
(
void
)
const
;
73
78
double
GetOrientation
(
void
)
const
;
79
80
private
:
81
86
void
SetVerticalBeamwidth
(
double
verticalBeamwidthDegrees);
87
92
void
SetHorizontalBeamwidth
(
double
horizontalBeamwidthDegrees);
93
98
void
SetOrientation
(
double
orientationDegrees);
99
105
static
double
GetExponentFromBeamwidth
(
double
beamwidthDegrees);
106
112
static
double
GetBeamwidthFromExponent
(
double
exponent);
113
114
double
m_verticalExponent
;
115
double
m_horizontalExponent
;
116
double
m_orientationRadians
;
117
double
m_maxGain
;
118
};
119
120
121
122
}
// namespace ns3
123
124
125
#endif
// COSINE_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::CosineAntennaModel
Cosine Antenna Model.
Definition:
cosine-antenna-model.h:51
ns3::CosineAntennaModel::m_maxGain
double m_maxGain
antenna gain in dB towards the main orientation
Definition:
cosine-antenna-model.h:117
ns3::CosineAntennaModel::SetHorizontalBeamwidth
void SetHorizontalBeamwidth(double horizontalBeamwidthDegrees)
Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model.
Definition:
cosine-antenna-model.cc:118
ns3::CosineAntennaModel::GetOrientation
double GetOrientation(void) const
Get the horizontal orientation of the antenna element.
Definition:
cosine-antenna-model.cc:148
ns3::CosineAntennaModel::GetGainDb
virtual double GetGainDb(Angles a)
this method is expected to be re-implemented by each antenna model
Definition:
cosine-antenna-model.cc:155
ns3::CosineAntennaModel::GetBeamwidthFromExponent
static double GetBeamwidthFromExponent(double exponent)
Compute the beamwidth of the cosine antenna model from the exponent.
Definition:
cosine-antenna-model.cc:97
ns3::CosineAntennaModel::GetExponentFromBeamwidth
static double GetExponentFromBeamwidth(double beamwidthDegrees)
Compute the exponent of the cosine antenna model from the beamwidth.
Definition:
cosine-antenna-model.cc:73
ns3::CosineAntennaModel::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
cosine-antenna-model.cc:38
ns3::CosineAntennaModel::GetVerticalBeamwidth
double GetVerticalBeamwidth(void) const
Get the vertical 3 dB beamwidth of the cosine antenna model.
Definition:
cosine-antenna-model.cc:126
ns3::CosineAntennaModel::GetHorizontalBeamwidth
double GetHorizontalBeamwidth(void) const
Get the horizontal 3 dB beamwidth of the cosine antenna model.
Definition:
cosine-antenna-model.cc:133
ns3::CosineAntennaModel::m_verticalExponent
double m_verticalExponent
exponent of the vertical direction
Definition:
cosine-antenna-model.h:114
ns3::CosineAntennaModel::SetVerticalBeamwidth
void SetVerticalBeamwidth(double verticalBeamwidthDegrees)
Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model.
Definition:
cosine-antenna-model.cc:110
ns3::CosineAntennaModel::SetOrientation
void SetOrientation(double orientationDegrees)
Set the horizontal orientation of the antenna element.
Definition:
cosine-antenna-model.cc:140
ns3::CosineAntennaModel::m_orientationRadians
double m_orientationRadians
orientation in radians in the horizontal direction (bearing)
Definition:
cosine-antenna-model.h:116
ns3::CosineAntennaModel::m_horizontalExponent
double m_horizontalExponent
exponent of the horizontal direction
Definition:
cosine-antenna-model.h:115
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.
src
antenna
model
cosine-antenna-model.h
Generated on Tue Feb 6 2024 19:21:14 for ns-3 by
1.9.1