A Discrete-Event Network Simulator
API
test-lte-antenna.cc
Go to the documentation of this file.
1/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011, 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: Manuel Requena <manuel.requena@cttc.es>
19 * Nicola Baldo <nbaldo@cttc.es>
20 */
21
22#include "ns3/simulator.h"
23#include "ns3/log.h"
24#include "ns3/string.h"
25#include "ns3/double.h"
26#include "ns3/enum.h"
27#include "ns3/boolean.h"
28#include "ns3/test.h"
29#include "ns3/mobility-helper.h"
30#include "ns3/lte-helper.h"
31
32#include "ns3/lte-ue-phy.h"
33#include "ns3/lte-ue-net-device.h"
34#include "ns3/lte-enb-phy.h"
35#include "ns3/lte-enb-net-device.h"
36#include "ns3/ff-mac-scheduler.h"
37
38#include "ns3/lte-global-pathloss-database.h"
39
40#include <ns3/lte-chunk-processor.h>
41
42
43using namespace ns3;
44
45NS_LOG_COMPONENT_DEFINE ("LteAntennaTest");
46
47
57class LteEnbAntennaTestCase : public TestCase
58{
59public:
68 static std::string BuildNameString (double orientationDegrees, double beamwidthDegrees, double x, double y);
78 LteEnbAntennaTestCase (double orientationDegrees, double beamwidthDegrees, double x, double y, double antennaGainDb);
79 LteEnbAntennaTestCase ();
80 virtual ~LteEnbAntennaTestCase ();
81
82private:
83 virtual void DoRun (void);
84
85 double m_orientationDegrees;
86 double m_beamwidthDegrees;
87 double m_x;
88 double m_y;
89 double m_antennaGainDb;
90};
91
92
93
94
95std::string LteEnbAntennaTestCase::BuildNameString (double orientationDegrees, double beamwidthDegrees, double x, double y)
96{
97 std::ostringstream oss;
98 oss << "o=" << orientationDegrees
99 << ", bw=" << beamwidthDegrees
100 << ", x=" << x
101 << ", y=" << y;
102 return oss.str ();
103}
104
105
106LteEnbAntennaTestCase::LteEnbAntennaTestCase (double orientationDegrees, double beamwidthDegrees, double x, double y, double antennaGainDb)
107 : TestCase (BuildNameString (orientationDegrees, beamwidthDegrees, x, y)),
108 m_orientationDegrees (orientationDegrees),
109 m_beamwidthDegrees (beamwidthDegrees),
110 m_x (x),
111 m_y (y),
112 m_antennaGainDb (antennaGainDb)
113{
114 NS_LOG_FUNCTION (this);
115}
116
117LteEnbAntennaTestCase::~LteEnbAntennaTestCase ()
118{
119}
120
121void
122LteEnbAntennaTestCase::DoRun (void)
123{
124 Config::Reset ();
125 Config::SetDefault ("ns3::LteSpectrumPhy::CtrlErrorModelEnabled", BooleanValue (false));
126 Config::SetDefault ("ns3::LteSpectrumPhy::DataErrorModelEnabled", BooleanValue (false));
127 Config::SetDefault ("ns3::LteHelper::UseIdealRrc", BooleanValue (true));
128
129 //Disable Uplink Power Control
130 Config::SetDefault ("ns3::LteUePhy::EnableUplinkPowerControl", BooleanValue (false));
131
132 Ptr<LteHelper> lteHelper = CreateObject<LteHelper> ();
133
134 // use 0dB Pathloss, since we are testing only the antenna gain
135 lteHelper->SetAttribute ("PathlossModel", StringValue ("ns3::ConstantSpectrumPropagationLossModel"));
136 lteHelper->SetPathlossModelAttribute ("Loss", DoubleValue (0.0));
137
138 // Create Nodes: eNodeB and UE
139 NodeContainer enbNodes;
140 NodeContainer ueNodes;
141 enbNodes.Create (1);
142 ueNodes.Create (1);
143 NodeContainer allNodes = NodeContainer ( enbNodes, ueNodes );
144
145 // Install Mobility Model
146 Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
147 positionAlloc->Add (Vector (0.0, 0.0, 0.0)); // eNB
148 positionAlloc->Add (Vector (m_x, m_y, 0.0)); // UE
149 MobilityHelper mobility;
150 mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
151 mobility.SetPositionAllocator (positionAlloc);
152 mobility.Install (allNodes);
153
154 // Create Devices and install them in the Nodes (eNB and UE)
155 NetDeviceContainer enbDevs;
156 NetDeviceContainer ueDevs;
157 lteHelper->SetSchedulerType ("ns3::RrFfMacScheduler");
158 lteHelper->SetSchedulerAttribute ("UlCqiFilter", EnumValue (FfMacScheduler::PUSCH_UL_CQI));
159 lteHelper->SetEnbAntennaModelType ("ns3::CosineAntennaModel");
160 lteHelper->SetEnbAntennaModelAttribute ("Orientation", DoubleValue (m_orientationDegrees));
161 lteHelper->SetEnbAntennaModelAttribute ("HorizontalBeamwidth", DoubleValue (m_beamwidthDegrees));
162 lteHelper->SetEnbAntennaModelAttribute ("MaxGain", DoubleValue (0.0));
163
164 // set DL and UL bandwidth.
165 lteHelper->SetEnbDeviceAttribute ("DlBandwidth", UintegerValue (25));
166 lteHelper->SetEnbDeviceAttribute ("UlBandwidth", UintegerValue (25));
167
168 enbDevs = lteHelper->InstallEnbDevice (enbNodes);
169 ueDevs = lteHelper->InstallUeDevice (ueNodes);
170
171 // Attach a UE to a eNB
172 lteHelper->Attach (ueDevs, enbDevs.Get (0));
173
174 // Activate the default EPS bearer
175 enum EpsBearer::Qci q = EpsBearer::NGBR_VIDEO_TCP_DEFAULT;
176 EpsBearer bearer (q);
177 lteHelper->ActivateDataRadioBearer (ueDevs, bearer);
178
179 // Use testing chunk processor in the PHY layer
180 // It will be used to test that the SNR is as intended
181 Ptr<LtePhy> uePhy = ueDevs.Get (0)->GetObject<LteUeNetDevice> ()->GetPhy ()->GetObject<LtePhy> ();
182 Ptr<LteChunkProcessor> testDlSinr = Create<LteChunkProcessor> ();
183 LteSpectrumValueCatcher dlSinrCatcher;
184 testDlSinr->AddCallback (MakeCallback (&LteSpectrumValueCatcher::ReportValue, &dlSinrCatcher));
185 uePhy->GetDownlinkSpectrumPhy ()->AddDataSinrChunkProcessor (testDlSinr);
186
187 Ptr<LtePhy> enbphy = enbDevs.Get (0)->GetObject<LteEnbNetDevice> ()->GetPhy ()->GetObject<LtePhy> ();
188 Ptr<LteChunkProcessor> testUlSinr = Create<LteChunkProcessor> ();
189 LteSpectrumValueCatcher ulSinrCatcher;
190 testUlSinr->AddCallback (MakeCallback (&LteSpectrumValueCatcher::ReportValue, &ulSinrCatcher));
191 enbphy->GetUplinkSpectrumPhy ()->AddDataSinrChunkProcessor (testUlSinr);
192
193
194 // keep track of all path loss values in two centralized objects
195 DownlinkLteGlobalPathlossDatabase dlPathlossDb;
196 UplinkLteGlobalPathlossDatabase ulPathlossDb;
197 // we rely on the fact that LteHelper creates the DL channel object first, then the UL channel object,
198 // hence the former will have index 0 and the latter 1
199 Config::Connect ("/ChannelList/0/PathLoss",
200 MakeCallback (&DownlinkLteGlobalPathlossDatabase::UpdatePathloss, &dlPathlossDb));
201 Config::Connect ("/ChannelList/1/PathLoss",
202 MakeCallback (&UplinkLteGlobalPathlossDatabase::UpdatePathloss, &ulPathlossDb));
203
204 Simulator::Stop (Seconds (0.035));
205 Simulator::Run ();
206
207 const double enbTxPowerDbm = 30; // default eNB TX power over whole bandwidth
208 const double ueTxPowerDbm = 10; // default UE TX power over whole bandwidth
209 const double ktDbm = -174; // reference LTE noise PSD
210 const double noisePowerDbm = ktDbm + 10 * std::log10 (25 * 180000); // corresponds to kT*bandwidth in linear units
211 const double ueNoiseFigureDb = 9.0; // default UE noise figure
212 const double enbNoiseFigureDb = 5.0; // default eNB noise figure
213 double tolerance = (m_antennaGainDb != 0) ? std::abs (m_antennaGainDb) * 0.001 : 0.001;
214
215 // first test with SINR from LteChunkProcessor
216 // this can only be done for not-too-bad SINR otherwise the measurement won't be available
217 double expectedSinrDl = enbTxPowerDbm + m_antennaGainDb - noisePowerDbm + ueNoiseFigureDb;
218 if (expectedSinrDl > 0)
219 {
220 double calculatedSinrDbDl = -INFINITY;
221 if (dlSinrCatcher.GetValue () != 0)
222 {
223 calculatedSinrDbDl = 10.0 * std::log10 (dlSinrCatcher.GetValue ()->operator[] (0));
224 }
225 // remember that propagation loss is 0dB
226 double calculatedAntennaGainDbDl = - (enbTxPowerDbm - calculatedSinrDbDl - noisePowerDbm - ueNoiseFigureDb);
227 NS_LOG_INFO ("expected " << m_antennaGainDb << " actual " << calculatedAntennaGainDbDl << " tol " << tolerance);
228 NS_TEST_ASSERT_MSG_EQ_TOL (calculatedAntennaGainDbDl, m_antennaGainDb, tolerance, "Wrong DL antenna gain!");
229 }
230 double expectedSinrUl = ueTxPowerDbm + m_antennaGainDb - noisePowerDbm + enbNoiseFigureDb;
231 if (expectedSinrUl > 0)
232 {
233 double calculatedSinrDbUl = -INFINITY;
234 if (ulSinrCatcher.GetValue () != 0)
235 {
236 calculatedSinrDbUl = 10.0 * std::log10 (ulSinrCatcher.GetValue ()->operator[] (0));
237 }
238 double calculatedAntennaGainDbUl = - (ueTxPowerDbm - calculatedSinrDbUl - noisePowerDbm - enbNoiseFigureDb);
239 NS_TEST_ASSERT_MSG_EQ_TOL (calculatedAntennaGainDbUl, m_antennaGainDb, tolerance, "Wrong UL antenna gain!");
240 }
241
242
243 // repeat the same tests with the LteGlobalPathlossDatabases
244 double measuredLossDl = dlPathlossDb.GetPathloss (1, 1);
245 NS_TEST_ASSERT_MSG_EQ_TOL (measuredLossDl, -m_antennaGainDb, tolerance, "Wrong DL loss!");
246 double measuredLossUl = ulPathlossDb.GetPathloss (1, 1);
247 NS_TEST_ASSERT_MSG_EQ_TOL (measuredLossUl, -m_antennaGainDb, tolerance, "Wrong UL loss!");
248
249
250 Simulator::Destroy ();
251}
252
253
260class LteAntennaTestSuite : public TestSuite
261{
262public:
263 LteAntennaTestSuite ();
264};
265
266
267LteAntennaTestSuite::LteAntennaTestSuite ()
268 : TestSuite ("lte-antenna", SYSTEM)
269{
270 NS_LOG_FUNCTION (this);
271
272 // orientation beamwidth x y gain
273 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 90.0, 1.0, 0.0, 0.0), TestCase::QUICK);
274 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 90.0, 1.0, 1.0, -3.0), TestCase::QUICK);
275 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 90.0, 1.0, -1.0, -3.0), TestCase::QUICK);
276 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 90.0, -1.0, -1.0, -36.396), TestCase::QUICK);
277 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 90.0, -1.0, -0.0, -1414.6), TestCase::QUICK);
278 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 90.0, -1.0, 1.0, -36.396), TestCase::QUICK);
279 AddTestCase (new LteEnbAntennaTestCase ( 45.0, 90.0, 1.0, 1.0, 0.0), TestCase::QUICK);
280 AddTestCase (new LteEnbAntennaTestCase ( -45.0, 90.0, 1.0, -1.0, 0.0), TestCase::QUICK);
281 AddTestCase (new LteEnbAntennaTestCase ( 90.0, 90.0, 1.0, 1.0, -3.0), TestCase::QUICK);
282 AddTestCase (new LteEnbAntennaTestCase ( -90.0, 90.0, 1.0, -1.0, -3.0), TestCase::QUICK);
283
284 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 120.0, 1.0, 0.0, 0.0), TestCase::QUICK);
285 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 120.0, 0.5, sin(M_PI/3), -3.0), TestCase::QUICK);
286 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 120.0, 0.5, -sin(M_PI/3), -3.0), TestCase::QUICK);
287 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 120.0, -1.0, -2.0, -13.410), TestCase::QUICK);
288 AddTestCase (new LteEnbAntennaTestCase ( 0.0, 120.0, -1.0, 1.0, -20.034), TestCase::QUICK);
289 AddTestCase (new LteEnbAntennaTestCase ( 60.0, 120.0, 0.5, sin(M_PI/3), 0.0), TestCase::QUICK);
290 AddTestCase (new LteEnbAntennaTestCase ( -60.0, 120.0, 0.5, -sin(M_PI/3), 0.0), TestCase::QUICK);
291 AddTestCase (new LteEnbAntennaTestCase ( -60.0, 120.0, 0.5, -sin(M_PI/3), 0.0), TestCase::QUICK);
292 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, -0.5, -sin(M_PI/3), 0.0), TestCase::QUICK);
293 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, 0.5, -sin(M_PI/3), -3.0), TestCase::QUICK);
294 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, -1, 0, -3.0), TestCase::QUICK);
295 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, -1, 2, -15.578), TestCase::QUICK);
296 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, 1, 0, -14.457), TestCase::QUICK);
297 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, 1, 2, -73.154), TestCase::QUICK);
298 AddTestCase (new LteEnbAntennaTestCase ( -120.0, 120.0, 1, -0.1, -12.754), TestCase::QUICK);
299
300
301}
302
303static LteAntennaTestSuite lteAntennaTestSuite;
LteAntennaTestSuite
Lte Enb Antenna Test Suite.
Definition: test-lte-antenna.cc:261
LteEnbAntennaTestCase
Tests that the propagation model and the antenna parameters are generate the correct values.
Definition: test-lte-antenna.cc:58
LteEnbAntennaTestCase::m_orientationDegrees
double m_orientationDegrees
antenna orientation in degrees
Definition: test-lte-antenna.cc:85
LteEnbAntennaTestCase::m_antennaGainDb
double m_antennaGainDb
antenna gain in dB
Definition: test-lte-antenna.cc:89
LteEnbAntennaTestCase::BuildNameString
static std::string BuildNameString(double orientationDegrees, double beamwidthDegrees, double x, double y)
Build name string.
Definition: test-lte-antenna.cc:95
LteEnbAntennaTestCase::DoRun
virtual void DoRun(void)
Implementation to actually run this TestCase.
Definition: test-lte-antenna.cc:122
LteEnbAntennaTestCase::m_x
double m_x
x position of the UE
Definition: test-lte-antenna.cc:87
LteEnbAntennaTestCase::m_beamwidthDegrees
double m_beamwidthDegrees
antenna beamwidth in degrees
Definition: test-lte-antenna.cc:86
LteEnbAntennaTestCase::m_y
double m_y
y position of the UE
Definition: test-lte-antenna.cc:88
ns3::BooleanValue
AttributeValue implementation for Boolean.
Definition: boolean.h:37
ns3::DoubleValue
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
ns3::EnumValue
Hold variables of type enum.
Definition: enum.h:55
ns3::EpsBearer
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:92
ns3::EpsBearer::Qci
Qci
QoS Class Indicator.
Definition: eps-bearer.h:107
ns3::LteEnbNetDevice
The eNodeB device implementation.
Definition: lte-enb-net-device.h:57
ns3::LteGlobalPathlossDatabase::GetPathloss
double GetPathloss(uint16_t cellId, uint64_t imsi)
Definition: lte-global-pathloss-database.cc:56
ns3::LteHelper::SetSchedulerAttribute
void SetSchedulerAttribute(std::string n, const AttributeValue &v)
Set an attribute for the scheduler to be created.
Definition: lte-helper.cc:293
ns3::LteHelper::InstallEnbDevice
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:474
ns3::LteHelper::SetEnbAntennaModelType
void SetEnbAntennaModelType(std::string type)
Set the type of antenna model to be used by eNodeB devices.
Definition: lte-helper.cc:408
ns3::LteHelper::SetSchedulerType
void SetSchedulerType(std::string type)
Set the type of scheduler to be used by eNodeB devices.
Definition: lte-helper.cc:279
ns3::LteHelper::Attach
void Attach(NetDeviceContainer ueDevices)
Enables automatic attachment of a set of UE devices to a suitable cell using Idle mode initial cell s...
Definition: lte-helper.cc:959
ns3::LteHelper::SetPathlossModelAttribute
void SetPathlossModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the path loss models to be created.
Definition: lte-helper.cc:393
ns3::LteHelper::SetEnbAntennaModelAttribute
void SetEnbAntennaModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the eNodeB antenna model to be created.
Definition: lte-helper.cc:415
ns3::LteHelper::SetEnbDeviceAttribute
void SetEnbDeviceAttribute(std::string n, const AttributeValue &v)
Set an attribute for the eNodeB devices (LteEnbNetDevice) to be created.
Definition: lte-helper.cc:400
ns3::LteHelper::ActivateDataRadioBearer
void ActivateDataRadioBearer(NetDeviceContainer ueDevices, EpsBearer bearer)
Activate a Data Radio Bearer on a given UE devices (for LTE-only simulation).
Definition: lte-helper.cc:1313
ns3::LteHelper::InstallUeDevice
NetDeviceContainer InstallUeDevice(NodeContainer c)
Create a set of UE devices.
Definition: lte-helper.cc:489
ns3::LtePhy
The LtePhy models the physical layer of LTE.
Definition: lte-phy.h:53
ns3::LteSpectrumValueCatcher
A sink to be plugged to the callback of LteChunkProcessor allowing to save and later retrieve the lat...
Definition: lte-chunk-processor.h:104
ns3::LteSpectrumValueCatcher::GetValue
Ptr< SpectrumValue > GetValue()
Definition: lte-chunk-processor.cc:97
ns3::LteUeNetDevice
The LteUeNetDevice class implements the UE net device.
Definition: lte-ue-net-device.h:57
ns3::MobilityHelper
Helper class used to assign positions and mobility models to nodes.
Definition: mobility-helper.h:43
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:42
ns3::NetDeviceContainer::Get
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr<NetDevice> stored in this container at a given index.
Definition: net-device-container.cc:62
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:39
ns3::NodeContainer::Create
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Definition: node-container.cc:98
ns3::ObjectBase::SetAttribute
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:256
ns3::Object::GetObject
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:470
ns3::StringValue
Hold variables of type string.
Definition: string.h:41
ns3::TestCase
encapsulates test code
Definition: test.h:994
ns3::TestCase::AddTestCase
void AddTestCase(TestCase *testCase, TestDuration duration=QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:299
ns3::TestSuite
A suite of tests to run.
Definition: test.h:1188
ns3::UintegerValue
Hold an unsigned integer type.
Definition: uinteger.h:44
ns3::Config::Reset
void Reset(void)
Reset the initial value of every attribute as well as the value of every global to what they were bef...
Definition: config.cc:820
ns3::Config::SetDefault
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:849
ns3::Config::Connect
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:920
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:244
NS_LOG_INFO
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
NS_TEST_ASSERT_MSG_EQ_TOL
#define NS_TEST_ASSERT_MSG_EQ_TOL(actual, limit, tol, msg)
Test that actual and expected (limit) values are equal to plus or minus some tolerance and report and...
Definition: test.h:323
ns3::Seconds
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::MakeCallback
Callback< R, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648
sample-rng-plot.x
list x
Random number samples.
Definition: sample-rng-plot.py:37
third.mobility
mobility
Definition: third.py:107
lteAntennaTestSuite
static LteAntennaTestSuite lteAntennaTestSuite
Definition: test-lte-antenna.cc:303