A Discrete-Event Network Simulator
API
lte-hex-grid-enb-topology-helper.cc
Go to the documentation of this file.
1/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright 2012 Centre Tecnologic de Telecomunicacions de Catalunya (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
23#include <ns3/double.h>
24#include <ns3/log.h>
25#include <ns3/abort.h>
26#include <ns3/pointer.h>
27#include <ns3/epc-helper.h>
28#include <iostream>
29
30
31namespace ns3 {
32
33NS_LOG_COMPONENT_DEFINE ("LteHexGridEnbTopologyHelper");
34
35NS_OBJECT_ENSURE_REGISTERED (LteHexGridEnbTopologyHelper);
36
38{
39 NS_LOG_FUNCTION (this);
40}
41
43{
44 NS_LOG_FUNCTION (this);
45}
46
48{
49 static TypeId
50 tid =
51 TypeId ("ns3::LteHexGridEnbTopologyHelper")
52 .SetParent<Object> ()
53 .AddConstructor<LteHexGridEnbTopologyHelper> ()
54 .AddAttribute ("InterSiteDistance",
55 "The distance [m] between nearby sites",
56 DoubleValue (500),
58 MakeDoubleChecker<double> ())
59 .AddAttribute ("SectorOffset",
60 "The offset [m] in the position for the node of each sector with respect "
61 "to the center of the three-sector site",
62 DoubleValue (0.5),
64 MakeDoubleChecker<double> ())
65 .AddAttribute ("SiteHeight",
66 "The height [m] of each site",
67 DoubleValue (30),
69 MakeDoubleChecker<double> ())
70 .AddAttribute ("MinX", "The x coordinate where the hex grid starts.",
71 DoubleValue (0.0),
73 MakeDoubleChecker<double> ())
74 .AddAttribute ("MinY", "The y coordinate where the hex grid starts.",
75 DoubleValue (0.0),
77 MakeDoubleChecker<double> ())
78 .AddAttribute ("GridWidth", "The number of sites in even rows (odd rows will have one additional site).",
79 UintegerValue (1),
81 MakeUintegerChecker<uint32_t> ())
82 ;
83 return tid;
84}
85
86void
88{
89 NS_LOG_FUNCTION (this);
91}
92
93
94void
96{
97 NS_LOG_FUNCTION (this << h);
98 m_lteHelper = h;
99}
100
103{
104 NS_LOG_FUNCTION (this);
105 NetDeviceContainer enbDevs;
106 const double xydfactor = std::sqrt (0.75);
107 double yd = xydfactor*m_d;
108 for (uint32_t n = 0; n < c.GetN (); ++n)
109 {
110 uint32_t currentSite = n / 3;
111 uint32_t biRowIndex = (currentSite / (m_gridWidth + m_gridWidth + 1));
112 uint32_t biRowRemainder = currentSite % (m_gridWidth + m_gridWidth + 1);
113 uint32_t rowIndex = biRowIndex*2;
114 uint32_t colIndex = biRowRemainder;
115 if (biRowRemainder >= m_gridWidth)
116 {
117 ++rowIndex;
118 colIndex -= m_gridWidth;
119 }
120 NS_LOG_LOGIC ("node " << n << " site " << currentSite
121 << " rowIndex " << rowIndex
122 << " colIndex " << colIndex
123 << " biRowIndex " << biRowIndex
124 << " biRowRemainder " << biRowRemainder);
125 double y = m_yMin + yd * rowIndex;
126 double x;
127 double antennaOrientation;
128 if ((rowIndex % 2) == 0)
129 {
130 x = m_xMin + m_d * colIndex;
131 }
132 else // row is odd
133 {
134 x = m_xMin -(0.5*m_d) + m_d * colIndex;
135 }
136
137 switch (n%3)
138 {
139 case 0:
140 antennaOrientation = 0;
141 x += m_offset;
143 break;
144
145 case 1:
146 antennaOrientation = 120;
147 x -= m_offset/2.0;
148 y += m_offset*xydfactor;
150 break;
151
152 case 2:
153 antennaOrientation = -120;
154 x -= m_offset/2.0;
155 y -= m_offset*xydfactor;
157 break;
158
159 // no default, n%3 = 0, 1, 2
160 }
161 Ptr<Node> node = c.Get (n);
163 Vector pos (x, y, m_siteHeight);
164 NS_LOG_LOGIC ("node " << n << " at " << pos << " antennaOrientation " << antennaOrientation);
165 mm->SetPosition (Vector (x, y, m_siteHeight));
166 m_lteHelper->SetEnbAntennaModelAttribute ("Orientation", DoubleValue (antennaOrientation));
167 enbDevs.Add (m_lteHelper->InstallEnbDevice (node));
168 }
169 return enbDevs;
170}
171
172} // namespace ns3
173
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:474
void SetFfrAlgorithmAttribute(std::string n, const AttributeValue &v)
Set an attribute for the FFR algorithm to be created.
Definition: lte-helper.cc:314
void SetEnbAntennaModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the eNodeB antenna model to be created.
Definition: lte-helper.cc:415
static TypeId GetTypeId(void)
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)
virtual void DoDispose(void)
Destructor implementation.
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.
void SetPosition(const Vector &position)
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(void) 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:88
virtual void DoDispose(void)
Destructor implementation.
Definition: object.cc:346
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:470
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
Hold an unsigned integer type.
Definition: uinteger.h:44
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Definition: double.h:42
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:45
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:289
#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:45
Every class exported by the ns3 library is enclosed in the ns3 namespace.