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
antenna-model.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2011 CTTC
3
*
4
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Author: Nicola Baldo <nbaldo@cttc.es>
7
*/
8
9
#ifndef ANTENNA_MODEL_H
10
#define ANTENNA_MODEL_H
11
12
#include "
angles.h
"
13
14
#include <ns3/object.h>
15
16
namespace
ns3
17
{
18
19
/**
20
* @defgroup antenna Antenna module
21
* @brief This module contains several antenna
22
* radiation pattern models.
23
*/
24
25
/**
26
* @ingroup antenna
27
* @ingroup tests
28
* @defgroup antenna-tests Antenna module tests
29
*/
30
31
/**
32
* @ingroup antenna
33
*
34
* @brief interface for antenna radiation pattern models
35
*
36
* This class provides an interface for the definition of antenna
37
* radiation pattern models. This interface is based on the use of
38
* spherical coordinates, in particular of the azimuth and inclination
39
* angles. This choice is the one proposed "Antenna Theory - Analysis
40
* and Design", C.A. Balanis, Wiley, 2nd Ed., see in particular
41
* section 2.2 "Radiation pattern".
42
*/
43
class
AntennaModel
:
public
Object
44
{
45
public
:
46
AntennaModel
();
47
~AntennaModel
()
override
;
48
49
/**
50
* @brief Get the type ID.
51
* @return The object TypeId.
52
*/
53
static
TypeId
GetTypeId
();
54
55
/**
56
* this method is expected to be re-implemented by each antenna model
57
*
58
* @param a the spherical angles at which the radiation pattern should
59
* be evaluated
60
*
61
* @return the power gain in dBi of the antenna radiation pattern at
62
* the specified angles; dBi means dB with respect to the gain of an
63
* isotropic radiator. Since a power gain is used, the efficiency of
64
* the antenna is expected to be included in the gain value.
65
*/
66
virtual
double
GetGainDb
(
Angles
a) = 0;
67
};
68
69
}
// namespace ns3
70
71
#endif
// ANTENNA_MODEL_H
angles.h
ns3::Angles
Class holding the azimuth and inclination angles of spherical coordinates.
Definition
angles.h:107
ns3::AntennaModel
interface for antenna radiation pattern models
Definition
antenna-model.h:44
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:31
ns3::AntennaModel::~AntennaModel
~AntennaModel() override
Definition
antenna-model.cc:26
ns3::AntennaModel::AntennaModel
AntennaModel()
Definition
antenna-model.cc:22
ns3::Object
A base class which provides memory management and object aggregation.
Definition
object.h:78
ns3::TypeId
a unique identifier for an interface.
Definition
type-id.h:48
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
antenna
model
antenna-model.h
Generated on Sun Dec 1 2024 18:20:35 for ns-3 by
1.11.0