A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
cosine-antenna-model.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2011 CTTC
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Author: Nicola Baldo <nbaldo@cttc.es>
18
*/
19
20
#ifndef COSINE_ANTENNA_MODEL_H
21
#define COSINE_ANTENNA_MODEL_H
22
23
#include "
antenna-model.h
"
24
25
#include <ns3/object.h>
26
27
namespace
ns3
28
{
29
30
/**
31
* \ingroup antenna
32
*
33
* \brief Cosine Antenna Model
34
*
35
* This class implements the cosine model, similarly to what is described in:
36
* Cosine Antenna Element, Mathworks, Phased Array System Toolbox (Sep. 2020)
37
* Available online: https://www.mathworks.com/help/phased/ug/cosine-antenna-element.html
38
*
39
* The power pattern of the element is equal to:
40
// P(az,el) = cos(az/2)^2m * cos(pi/2 - incl/2)^2n,
41
// where az is the azimuth angle, and incl is the inclination angle.
42
*
43
* Differently from the source, the response is defined for azimuth and elevation angles
44
* between –180 and 180 degrees and is always positive.
45
* There is no response at the backside of a cosine antenna.
46
* The cosine response pattern achieves a maximum value of 1 (0 dB) at 0 degrees azimuth
47
* and 90 degrees inclination.
48
* An extra settable gain is added to the original model, to improve its generality.
49
*/
50
class
CosineAntennaModel
:
public
AntennaModel
51
{
52
public
:
53
/**
54
* \brief Get the type ID.
55
* \return The object TypeId.
56
*/
57
static
TypeId
GetTypeId
();
58
59
// inherited from AntennaModel
60
double
GetGainDb
(
Angles
a)
override
;
61
62
/**
63
* Get the vertical 3 dB beamwidth of the cosine antenna model.
64
* \return the vertical beamwidth in degrees
65
*/
66
double
GetVerticalBeamwidth
()
const
;
67
68
/**
69
* Get the horizontal 3 dB beamwidth of the cosine antenna model.
70
* \return the horizontal beamwidth in degrees
71
*/
72
double
GetHorizontalBeamwidth
()
const
;
73
74
/**
75
* Get the horizontal orientation of the antenna element.
76
* \return the horizontal orientation in degrees
77
*/
78
double
GetOrientation
()
const
;
79
80
private
:
81
/**
82
* Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model.
83
* \param verticalBeamwidthDegrees the vertical beamwidth in degrees
84
*/
85
void
SetVerticalBeamwidth
(
double
verticalBeamwidthDegrees);
86
87
/**
88
* Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model.
89
* \param horizontalBeamwidthDegrees the horizontal beamwidth in degrees
90
*/
91
void
SetHorizontalBeamwidth
(
double
horizontalBeamwidthDegrees);
92
93
/**
94
* Set the horizontal orientation of the antenna element.
95
* \param orientationDegrees the horizontal orientation in degrees
96
*/
97
void
SetOrientation
(
double
orientationDegrees);
98
99
/**
100
* Compute the exponent of the cosine antenna model from the beamwidth
101
* \param beamwidthDegrees the beamwidth in degrees
102
* \return the exponent
103
*/
104
static
double
GetExponentFromBeamwidth
(
double
beamwidthDegrees);
105
106
/**
107
* Compute the beamwidth of the cosine antenna model from the exponent
108
* \param exponent the exponent
109
* \return beamwidth in degrees
110
*/
111
static
double
GetBeamwidthFromExponent
(
double
exponent);
112
113
double
m_verticalExponent
;
//!< exponent of the vertical direction
114
double
m_horizontalExponent
;
//!< exponent of the horizontal direction
115
double
m_orientationRadians
;
//!< orientation in radians in the horizontal direction (bearing)
116
double
m_maxGain
;
//!< antenna gain in dB towards the main orientation
117
};
118
119
}
// namespace ns3
120
121
#endif
// COSINE_ANTENNA_MODEL_H
antenna-model.h
ns3::Angles
Class holding the azimuth and inclination angles of spherical coordinates.
Definition:
angles.h:118
ns3::AntennaModel
interface for antenna radiation pattern models
Definition:
antenna-model.h:55
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:116
ns3::CosineAntennaModel::SetHorizontalBeamwidth
void SetHorizontalBeamwidth(double horizontalBeamwidthDegrees)
Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model.
Definition:
cosine-antenna-model.cc:116
ns3::CosineAntennaModel::GetHorizontalBeamwidth
double GetHorizontalBeamwidth() const
Get the horizontal 3 dB beamwidth of the cosine antenna model.
Definition:
cosine-antenna-model.cc:129
ns3::CosineAntennaModel::GetGainDb
double GetGainDb(Angles a) override
this method is expected to be re-implemented by each antenna model
Definition:
cosine-antenna-model.cc:148
ns3::CosineAntennaModel::GetOrientation
double GetOrientation() const
Get the horizontal orientation of the antenna element.
Definition:
cosine-antenna-model.cc:142
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:74
ns3::CosineAntennaModel::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
cosine-antenna-model.cc:37
ns3::CosineAntennaModel::GetVerticalBeamwidth
double GetVerticalBeamwidth() const
Get the vertical 3 dB beamwidth of the cosine antenna model.
Definition:
cosine-antenna-model.cc:123
ns3::CosineAntennaModel::m_verticalExponent
double m_verticalExponent
exponent of the vertical direction
Definition:
cosine-antenna-model.h:113
ns3::CosineAntennaModel::SetVerticalBeamwidth
void SetVerticalBeamwidth(double verticalBeamwidthDegrees)
Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model.
Definition:
cosine-antenna-model.cc:109
ns3::CosineAntennaModel::SetOrientation
void SetOrientation(double orientationDegrees)
Set the horizontal orientation of the antenna element.
Definition:
cosine-antenna-model.cc:135
ns3::CosineAntennaModel::m_orientationRadians
double m_orientationRadians
orientation in radians in the horizontal direction (bearing)
Definition:
cosine-antenna-model.h:115
ns3::CosineAntennaModel::m_horizontalExponent
double m_horizontalExponent
exponent of the horizontal direction
Definition:
cosine-antenna-model.h:114
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 May 28 2024 23:33:59 for ns-3 by
1.9.6