A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
lte-hex-grid-enb-topology-helper.cc
Go to the documentation of this file.
1/*
2 * Copyright 2012 Centre Tecnologic de Telecomunicacions de Catalunya (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
21
22#include "epc-helper.h"
23
24#include <ns3/abort.h>
25#include <ns3/double.h>
26#include <ns3/log.h>
27#include <ns3/pointer.h>
28
29#include <iostream>
30
31namespace ns3
32{
33
34NS_LOG_COMPONENT_DEFINE("LteHexGridEnbTopologyHelper");
35
36NS_OBJECT_ENSURE_REGISTERED(LteHexGridEnbTopologyHelper);
37
39{
40 NS_LOG_FUNCTION(this);
41}
42
44{
45 NS_LOG_FUNCTION(this);
46}
47
50{
51 static TypeId tid =
52 TypeId("ns3::LteHexGridEnbTopologyHelper")
54 .AddConstructor<LteHexGridEnbTopologyHelper>()
55 .AddAttribute("InterSiteDistance",
56 "The distance [m] between nearby sites",
57 DoubleValue(500),
59 MakeDoubleChecker<double>())
60 .AddAttribute("SectorOffset",
61 "The offset [m] in the position for the node of each sector with respect "
62 "to the center of the three-sector site",
63 DoubleValue(0.5),
65 MakeDoubleChecker<double>())
66 .AddAttribute("SiteHeight",
67 "The height [m] of each site",
68 DoubleValue(30),
70 MakeDoubleChecker<double>())
71 .AddAttribute("MinX",
72 "The x coordinate where the hex grid starts.",
73 DoubleValue(0.0),
75 MakeDoubleChecker<double>())
76 .AddAttribute("MinY",
77 "The y coordinate where the hex grid starts.",
78 DoubleValue(0.0),
80 MakeDoubleChecker<double>())
81 .AddAttribute(
82 "GridWidth",
83 "The number of sites in even rows (odd rows will have one additional site).",
86 MakeUintegerChecker<uint32_t>());
87 return tid;
88}
89
90void
92{
93 NS_LOG_FUNCTION(this);
95}
96
97void
99{
100 NS_LOG_FUNCTION(this << h);
101 m_lteHelper = h;
102}
103
106{
107 NS_LOG_FUNCTION(this);
108 NetDeviceContainer enbDevs;
109 const double xydfactor = std::sqrt(0.75);
110 double yd = xydfactor * m_d;
111 for (uint32_t n = 0; n < c.GetN(); ++n)
112 {
113 uint32_t currentSite = n / 3;
114 uint32_t biRowIndex = (currentSite / (m_gridWidth + m_gridWidth + 1));
115 uint32_t biRowRemainder = currentSite % (m_gridWidth + m_gridWidth + 1);
116 uint32_t rowIndex = biRowIndex * 2;
117 uint32_t colIndex = biRowRemainder;
118 if (biRowRemainder >= m_gridWidth)
119 {
120 ++rowIndex;
121 colIndex -= m_gridWidth;
122 }
123 NS_LOG_LOGIC("node " << n << " site " << currentSite << " rowIndex " << rowIndex
124 << " colIndex " << colIndex << " biRowIndex " << biRowIndex
125 << " biRowRemainder " << biRowRemainder);
126 double y = m_yMin + yd * rowIndex;
127 double x;
128 double antennaOrientation;
129 if ((rowIndex % 2) == 0)
130 {
131 x = m_xMin + m_d * colIndex;
132 }
133 else // row is odd
134 {
135 x = m_xMin - (0.5 * m_d) + m_d * colIndex;
136 }
137
138 switch (n % 3)
139 {
140 case 0:
141 antennaOrientation = 0;
142 x += m_offset;
144 break;
145
146 case 1:
147 antennaOrientation = 120;
148 x -= m_offset / 2.0;
149 y += m_offset * xydfactor;
151 break;
152
153 case 2:
154 antennaOrientation = -120;
155 x -= m_offset / 2.0;
156 y -= m_offset * xydfactor;
158 break;
159
160 // no default, n%3 = 0, 1, 2
161 }
162 Ptr<Node> node = c.Get(n);
163 Ptr<MobilityModel> mm = node->GetObject<MobilityModel>();
164 Vector pos(x, y, m_siteHeight);
165 NS_LOG_LOGIC("node " << n << " at " << pos << " antennaOrientation " << antennaOrientation);
166 mm->SetPosition(Vector(x, y, m_siteHeight));
167 m_lteHelper->SetEnbAntennaModelAttribute("Orientation", DoubleValue(antennaOrientation));
168 enbDevs.Add(m_lteHelper->InstallEnbDevice(node));
169 }
170 return enbDevs;
171}
172
173} // namespace ns3
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:485
void SetFfrAlgorithmAttribute(std::string n, const AttributeValue &v)
Set an attribute for the FFR algorithm to be created.
Definition: lte-helper.cc:327
void SetEnbAntennaModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the eNodeB antenna model to be created.
Definition: lte-helper.cc:426
void DoDispose() override
Destructor implementation.
static TypeId GetTypeId()
Register this type.
double m_d
The distance [m] between nearby sites.
double m_xMin
The x coordinate where the hex grid starts.
Ptr< LteHelper > m_lteHelper
Pointer to LteHelper object.
double m_yMin
The y coordinate where the hex grid starts.
uint32_t m_gridWidth
The number of sites in even rows (odd rows will have one additional site)
NetDeviceContainer SetPositionAndInstallEnbDevice(NodeContainer c)
Position the nodes on a hex grid and install the corresponding EnbNetDevices with antenna boresight c...
double m_offset
The offset [m] in the position for the node of each sector with respect to the center of the three-se...
void SetLteHelper(Ptr< LteHelper > h)
Set the LteHelper to be used to actually create the EnbNetDevices.
uint32_t m_siteHeight
The height [m] of each site.
Keep track of the current position and velocity of an object.
holds a vector of ns3::NetDevice pointers
void Add(NetDeviceContainer other)
Append the contents of another NetDeviceContainer to the end of this container.
keep track of a set of node pointers.
uint32_t GetN() const
Get the number of Ptr<Node> stored in this container.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A base class which provides memory management and object aggregation.
Definition: object.h:89
virtual void DoDispose()
Destructor implementation.
Definition: object.cc:444
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:932
Hold an unsigned integer type.
Definition: uinteger.h:45
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Definition: double.h:43
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:46
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:282
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Every class exported by the ns3 library is enclosed in the ns3 namespace.