A Discrete-Event Network Simulator
API
lte-helper.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 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  * Modified by: Danilo Abrignani <danilo.abrignani@unibo.it> (Carrier Aggregation - GSoC 2015)
20  * Biljana Bojovic <biljana.bojovic@cttc.es> (Carrier Aggregation)
21  */
22 
23 #ifndef LTE_HELPER_H
24 #define LTE_HELPER_H
25 
26 #include <ns3/config.h>
27 #include <ns3/simulator.h>
28 #include <ns3/names.h>
29 #include <ns3/net-device.h>
30 #include <ns3/net-device-container.h>
31 #include <ns3/node.h>
32 #include <ns3/node-container.h>
33 #include <ns3/eps-bearer.h>
34 #include <ns3/phy-stats-calculator.h>
35 #include <ns3/phy-tx-stats-calculator.h>
36 #include <ns3/phy-rx-stats-calculator.h>
37 #include <ns3/mac-stats-calculator.h>
38 #include <ns3/radio-bearer-stats-calculator.h>
39 #include <ns3/radio-bearer-stats-connector.h>
40 #include <ns3/epc-tft.h>
41 #include <ns3/mobility-model.h>
42 #include <ns3/component-carrier-enb.h>
43 #include <ns3/cc-helper.h>
44 #include <map>
45 
46 namespace ns3 {
47 
48 
49 class LteUePhy;
50 class LteEnbPhy;
51 class SpectrumChannel;
52 class EpcHelper;
53 class PropagationLossModel;
54 class SpectrumPropagationLossModel;
55 
102 class LteHelper : public Object
103 {
104 public:
105  LteHelper (void);
106  virtual ~LteHelper (void);
107 
112  static TypeId GetTypeId (void);
113  virtual void DoDispose (void);
114 
128  void SetEpcHelper (Ptr<EpcHelper> h);
129 
137  void SetPathlossModelType (TypeId type);
138 
145  void SetPathlossModelAttribute (std::string n, const AttributeValue &v);
146 
156  void SetSchedulerType (std::string type);
157 
162  std::string GetSchedulerType () const;
163 
170  void SetSchedulerAttribute (std::string n, const AttributeValue &v);
171 
181  void SetFfrAlgorithmType (std::string type);
182 
187  std::string GetFfrAlgorithmType () const;
188 
195  void SetFfrAlgorithmAttribute (std::string n, const AttributeValue &v);
196 
206  void SetHandoverAlgorithmType (std::string type);
207 
212  std::string GetHandoverAlgorithmType () const;
213 
220  void SetHandoverAlgorithmAttribute (std::string n, const AttributeValue &v);
221 
228  void SetEnbDeviceAttribute (std::string n, const AttributeValue &v);
229 
237  void SetEnbAntennaModelType (std::string type);
238 
245  void SetEnbAntennaModelAttribute (std::string n, const AttributeValue &v);
246 
253  void SetUeDeviceAttribute (std::string n, const AttributeValue &v);
254 
262  void SetUeAntennaModelType (std::string type);
263 
270  void SetUeAntennaModelAttribute (std::string n, const AttributeValue &v);
271 
279  void SetSpectrumChannelType (std::string type);
280 
287  void SetSpectrumChannelAttribute (std::string n, const AttributeValue &v);
288 
295  void SetEnbComponentCarrierManagerType (std::string type);
296 
301  std::string GetEnbComponentCarrierManagerType () const;
302 
309  void SetEnbComponentCarrierManagerAttribute (std::string n, const AttributeValue &v);
310 
317  void SetUeComponentCarrierManagerType (std::string type);
318 
319 
324  std::string GetUeComponentCarrierManagerType () const;
325 
332  void SetUeComponentCarrierManagerAttribute (std::string n, const AttributeValue &v);
333 
341 
349 
367  void Attach (NetDeviceContainer ueDevices);
368 
386  void Attach (Ptr<NetDevice> ueDevice);
387 
401  void Attach (NetDeviceContainer ueDevices, Ptr<NetDevice> enbDevice);
402 
416  void Attach (Ptr<NetDevice> ueDevice, Ptr<NetDevice> enbDevice, uint8_t componentCarrierId = 0);
417 
432  void AttachToClosestEnb (NetDeviceContainer ueDevices, NetDeviceContainer enbDevices);
433 
448  void AttachToClosestEnb (Ptr<NetDevice> ueDevice, NetDeviceContainer enbDevices);
449 
458  uint8_t ActivateDedicatedEpsBearer (NetDeviceContainer ueDevices, EpsBearer bearer, Ptr<EpcTft> tft);
459 
468  uint8_t ActivateDedicatedEpsBearer (Ptr<NetDevice> ueDevice, EpsBearer bearer, Ptr<EpcTft> tft);
469 
479  void DeActivateDedicatedEpsBearer (Ptr<NetDevice> ueDevice, Ptr<NetDevice> enbDevice, uint8_t bearerId);
485  void AddX2Interface (NodeContainer enbNodes);
486 
493  void AddX2Interface (Ptr<Node> enbNode1, Ptr<Node> enbNode2);
494 
508  void HandoverRequest (Time hoTime, Ptr<NetDevice> ueDev,
509  Ptr<NetDevice> sourceEnbDev, Ptr<NetDevice> targetEnbDev);
510 
511 
524  void HandoverRequest (Time hoTime, Ptr<NetDevice> ueDev,
525  Ptr<NetDevice> sourceEnbDev, uint16_t targetCellId);
526 
533  void ActivateDataRadioBearer (NetDeviceContainer ueDevices, EpsBearer bearer);
534 
543  void ActivateDataRadioBearer (Ptr<NetDevice> ueDevice, EpsBearer bearer);
544 
552  void SetFadingModel (std::string type);
553 
560  void SetFadingModelAttribute (std::string n, const AttributeValue &v);
561 
565  void EnableLogComponents (void);
566 
572  void EnableTraces (void);
573 
577  void EnablePhyTraces (void);
578 
582  void EnableDlPhyTraces (void);
583 
587  void EnableUlPhyTraces (void);
588 
592  void EnableDlTxPhyTraces (void);
593 
597  void EnableUlTxPhyTraces (void);
598 
602  void EnableDlRxPhyTraces (void);
603 
607  void EnableUlRxPhyTraces (void);
608 
612  void EnableMacTraces (void);
613 
617  void EnableDlMacTraces (void);
618 
622  void EnableUlMacTraces (void);
623 
627  void EnableRlcTraces (void);
628 
634 
638  void EnablePdcpTraces (void);
639 
645 
660  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);
661 
666 
667 
672 
673 
674 protected:
675  // inherited from Object
676  virtual void DoInitialize (void);
677 
678 private:
679 
688  void DoComponentCarrierConfigure (uint32_t ulEarfcn, uint32_t dlEarfcn, uint16_t ulbw, uint16_t dlbw);
695 
702 
714  void DoHandoverRequest (Ptr<NetDevice> ueDev,
715  Ptr<NetDevice> sourceEnbDev,
716  uint16_t targetCellId);
717 
718 
728  void DoDeActivateDedicatedEpsBearer (Ptr<NetDevice> ueDevice, Ptr<NetDevice> enbDevice, uint8_t bearerId);
729 
731  void ChannelModelInitialization (void);
732 
745 
768 
770  std::string m_fadingModelType;
780 
795 
802 
808  uint64_t m_imsiCounter;
814  uint16_t m_cellIdCounter;
815 
832 
839  bool m_useCa;
840 
844  std::map< uint8_t, ComponentCarrier > m_componentCarrierPhyParams;
845 
849  uint16_t m_noOfCcs;
850 
851 }; // end of `class LteHelper`
852 
853 
854 } // namespace ns3
855 
856 
857 
858 #endif // LTE_HELPER_H
Hold a value for an Attribute.
Definition: attribute.h:69
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:92
Creation and configuration of LTE entities.
Definition: lte-helper.h:103
Ptr< SpectrumChannel > GetDownlinkSpectrumChannel(void) const
Definition: lte-helper.cc:218
void SetFfrAlgorithmType(std::string type)
Set the type of FFR algorithm to be used by eNodeB devices.
Definition: lte-helper.cc:306
void EnableUlPhyTraces(void)
Enable trace sinks for UL PHY layer.
Definition: lte-helper.cc:1561
Ptr< SpectrumPropagationLossModel > m_fadingModel
The fading model used in both the downlink and uplink channels.
Definition: lte-helper.h:774
Ptr< Object > m_uplinkPathlossModel
The path loss model used in the uplink channel.
Definition: lte-helper.h:744
Ptr< RadioBearerStatsCalculator > GetPdcpStats(void)
Definition: lte-helper.cc:1586
void SetEnbComponentCarrierManagerType(std::string type)
Set the type of carrier component algorithm to be used by eNodeB devices.
Definition: lte-helper.cc:349
void EnableLogComponents(void)
Enables full-blown logging for major components of the LENA architecture.
Definition: lte-helper.cc:1323
ObjectFactory m_schedulerFactory
Factory of MAC scheduler object.
Definition: lte-helper.h:747
void SetUeAntennaModelType(std::string type)
Set the type of antenna model to be used by UE devices.
Definition: lte-helper.cc:429
ObjectFactory m_ffrAlgorithmFactory
Factory of FFR (frequency reuse) algorithm object.
Definition: lte-helper.h:749
void EnableUlTxPhyTraces(void)
Enable trace sinks for UL transmission PHY layer.
Definition: lte-helper.cc:1507
ObjectFactory m_channelFactory
Factory of both the downlink and uplink LTE channels.
Definition: lte-helper.h:767
void SetEpcHelper(Ptr< EpcHelper > h)
Set the EpcHelper to be used to setup the EPC network in conjunction with the setup of the LTE radio ...
Definition: lte-helper.cc:272
ObjectFactory m_handoverAlgorithmFactory
Factory of handover algorithm object.
Definition: lte-helper.h:751
std::string m_fadingModelType
Name of fading model type, e.g., "ns3::TraceFadingLossModel".
Definition: lte-helper.h:770
ObjectFactory m_enbComponentCarrierManagerFactory
Factory of enb component carrier manager object.
Definition: lte-helper.h:753
void SetFadingModel(std::string type)
Set the type of fading model to be used in both DL and UL.
Definition: lte-helper.cc:443
void DoDeActivateDedicatedEpsBearer(Ptr< NetDevice > ueDevice, Ptr< NetDevice > enbDevice, uint8_t bearerId)
The actual function to trigger a manual bearer de-activation.
Definition: lte-helper.cc:1282
std::string GetEnbComponentCarrierManagerType() const
Definition: lte-helper.cc:343
void SetSchedulerAttribute(std::string n, const AttributeValue &v)
Set an attribute for the scheduler to be created.
Definition: lte-helper.cc:293
void ChannelModelInitialization(void)
Function that performs a channel model initialization of all component carriers.
Definition: lte-helper.cc:224
virtual void DoInitialize(void)
Initialize() implementation.
Definition: lte-helper.cc:89
Ptr< MacStatsCalculator > m_macStats
Container of MAC layer statistics.
Definition: lte-helper.h:788
void SetHandoverAlgorithmAttribute(std::string n, const AttributeValue &v)
Set an attribute for the handover algorithm to be created.
Definition: lte-helper.cc:335
void DeActivateDedicatedEpsBearer(Ptr< NetDevice > ueDevice, Ptr< NetDevice > enbDevice, uint8_t bearerId)
Manually trigger dedicated bearer de-activation at specific simulation time.
Definition: lte-helper.cc:1272
void HandoverRequest(Time hoTime, Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, Ptr< NetDevice > targetEnbDev)
Manually trigger an X2-based handover.
Definition: lte-helper.cc:1245
Ptr< SpectrumChannel > m_downlinkChannel
This function create the component carrier based on provided configuration parameters.
Definition: lte-helper.h:738
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:474
void SetUeComponentCarrierManagerAttribute(std::string n, const AttributeValue &v)
Set an attribute for the ue component carrier manager to be created.
Definition: lte-helper.cc:378
uint16_t m_cellIdCounter
Keep track of the number of cell ID allocated.
Definition: lte-helper.h:814
std::string GetFfrAlgorithmType() const
Definition: lte-helper.cc:300
void SetHandoverAlgorithmType(std::string type)
Set the type of handover algorithm to be used by eNodeB devices.
Definition: lte-helper.cc:327
void SetPathlossModelType(TypeId type)
Set the type of path loss model to be used for both DL and UL channels.
Definition: lte-helper.cc:385
Ptr< PhyTxStatsCalculator > m_phyTxStats
Container of PHY layer statistics related to transmission.
Definition: lte-helper.h:784
Ptr< RadioBearerStatsCalculator > GetRlcStats(void)
Definition: lte-helper.cc:1572
void SetEnbAntennaModelType(std::string type)
Set the type of antenna model to be used by eNodeB devices.
Definition: lte-helper.cc:408
void SetFfrAlgorithmAttribute(std::string n, const AttributeValue &v)
Set an attribute for the FFR algorithm to be created.
Definition: lte-helper.cc:314
void DoHandoverRequest(Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, uint16_t targetCellId)
The actual function to trigger a manual handover.
Definition: lte-helper.cc:1262
bool m_isAnrEnabled
The AnrEnabled attribute.
Definition: lte-helper.h:825
void SetEnbComponentCarrierManagerAttribute(std::string n, const AttributeValue &v)
Set an attribute for the enb component carrier manager to be created.
Definition: lte-helper.cc:357
Ptr< PhyRxStatsCalculator > m_phyRxStats
Container of PHY layer statistics related to reception.
Definition: lte-helper.h:786
void SetSpectrumChannelType(std::string type)
Set the type of spectrum channel to be used in both DL and UL.
Definition: lte-helper.cc:461
ObjectFactory m_pathlossModelFactory
Factory of path loss model object.
Definition: lte-helper.h:765
bool m_fadingStreamsAssigned
True if a random variable stream number has been assigned for the fading model.
Definition: lte-helper.h:779
Ptr< SpectrumChannel > GetUplinkSpectrumChannel(void) const
Definition: lte-helper.cc:212
std::string GetUeComponentCarrierManagerType() const
Definition: lte-helper.cc:364
void SetSchedulerType(std::string type)
Set the type of scheduler to be used by eNodeB devices.
Definition: lte-helper.cc:279
RadioBearerStatsConnector m_radioBearerStatsConnector
Connects RLC and PDCP statistics containers to appropriate trace sources.
Definition: lte-helper.h:794
void EnableDlPhyTraces(void)
Enable trace sinks for DL PHY layer.
Definition: lte-helper.cc:1553
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
ObjectFactory m_enbNetDeviceFactory
Factory of LteEnbNetDevice objects.
Definition: lte-helper.h:757
std::string GetHandoverAlgorithmType() const
Definition: lte-helper.cc:321
Ptr< PhyStatsCalculator > m_phyStats
Container of PHY layer statistics.
Definition: lte-helper.h:782
void SetPathlossModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the path loss models to be created.
Definition: lte-helper.cc:393
bool m_useIdealRrc
The UseIdealRrc attribute.
Definition: lte-helper.h:820
ObjectFactory m_ueComponentCarrierManagerFactory
Factory of ue component carrier manager object.
Definition: lte-helper.h:755
void DoComponentCarrierConfigure(uint32_t ulEarfcn, uint32_t dlEarfcn, uint16_t ulbw, uint16_t dlbw)
Configure the component carriers.
Definition: lte-helper.cc:1297
Ptr< Object > m_downlinkPathlossModel
The path loss model used in the downlink channel.
Definition: lte-helper.h:742
Ptr< RadioBearerStatsCalculator > m_pdcpStats
Container of PDCP layer statistics.
Definition: lte-helper.h:792
void EnableUlRxPhyTraces(void)
Enable trace sinks for UL reception PHY layer.
Definition: lte-helper.cc:1521
void EnableRlcTraces(void)
Enable trace sinks for RLC layer.
Definition: lte-helper.cc:1435
bool m_usePdschForCqiGeneration
The UsePdschForCqiGeneration attribute.
Definition: lte-helper.h:831
void SetUeAntennaModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the UE antenna model to be created.
Definition: lte-helper.cc:436
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.
Definition: lte-helper.cc:106
void SetEnbDeviceAttribute(std::string n, const AttributeValue &v)
Set an attribute for the eNodeB devices (LteEnbNetDevice) to be created.
Definition: lte-helper.cc:400
bool m_useCa
The UseCa attribute.
Definition: lte-helper.h:839
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
NetDeviceContainer InstallUeDevice(NodeContainer c)
Create a set of UE devices.
Definition: lte-helper.cc:489
void EnableDlMacTraces(void)
Enable trace sinks for DL MAC layer.
Definition: lte-helper.cc:1537
uint64_t m_imsiCounter
Keep track of the number of IMSI allocated.
Definition: lte-helper.h:808
ObjectFactory m_ueNetDeviceFactory
Factory for LteUeNetDevice objects.
Definition: lte-helper.h:761
virtual void DoDispose(void)
Destructor implementation.
Definition: lte-helper.cc:202
ObjectFactory m_ueAntennaModelFactory
Factory of antenna object for UE.
Definition: lte-helper.h:763
Ptr< SpectrumChannel > m_uplinkChannel
The uplink LTE channel used in the simulation.
Definition: lte-helper.h:740
void EnableUlMacTraces(void)
Enable trace sinks for UL MAC layer.
Definition: lte-helper.cc:1545
void EnablePhyTraces(void)
Enable trace sinks for PHY layer.
Definition: lte-helper.cc:1489
void SetSpectrumChannelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the spectrum channel to be created (both DL and UL).
Definition: lte-helper.cc:468
void AddX2Interface(NodeContainer enbNodes)
Create an X2 interface between all the eNBs in a given set.
Definition: lte-helper.cc:1220
void EnablePdcpTraces(void)
Enable trace sinks for PDCP layer.
Definition: lte-helper.cc:1578
void EnableDlRxPhyTraces(void)
Enable trace sinks for DL reception PHY layer.
Definition: lte-helper.cc:1514
void SetUeDeviceAttribute(std::string n, const AttributeValue &v)
Set an attribute for the UE devices (LteUeNetDevice) to be created.
Definition: lte-helper.cc:422
uint16_t m_noOfCcs
Number of component carriers that will be installed by default at eNodeB and UE devices.
Definition: lte-helper.h:849
int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used.
Definition: lte-helper.cc:1443
virtual ~LteHelper(void)
Definition: lte-helper.cc:101
void EnableTraces(void)
Enables trace sinks for PHY, MAC, RLC and PDCP.
Definition: lte-helper.cc:1426
std::map< uint8_t, ComponentCarrier > m_componentCarrierPhyParams
This contains all the information about each component carrier.
Definition: lte-helper.h:844
void SetFadingModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the fading model to be created (both DL and UL).
Definition: lte-helper.cc:455
Ptr< EpcHelper > m_epcHelper
Helper which provides implementation of core network.
Definition: lte-helper.h:801
void AttachToClosestEnb(NetDeviceContainer ueDevices, NetDeviceContainer enbDevices)
Manual attachment of a set of UE devices to the network via the closest eNodeB (with respect to dista...
Definition: lte-helper.cc:1036
uint8_t ActivateDedicatedEpsBearer(NetDeviceContainer ueDevices, EpsBearer bearer, Ptr< EpcTft > tft)
Activate a dedicated EPS bearer on a given set of UE devices.
Definition: lte-helper.cc:1068
ObjectFactory m_enbAntennaModelFactory
Factory of antenna object for eNodeB.
Definition: lte-helper.h:759
Ptr< RadioBearerStatsCalculator > m_rlcStats
Container of RLC layer statistics.
Definition: lte-helper.h:790
std::string GetSchedulerType() const
Definition: lte-helper.cc:287
void EnableDlTxPhyTraces(void)
Enable trace sinks for DL transmission PHY layer.
Definition: lte-helper.cc:1500
Ptr< NetDevice > InstallSingleUeDevice(Ptr< Node > n)
Create a UE device (LteUeNetDevice) on the given node.
Definition: lte-helper.cc:760
Ptr< NetDevice > InstallSingleEnbDevice(Ptr< Node > n)
Create an eNodeB device (LteEnbNetDevice) on the given node.
Definition: lte-helper.cc:504
void SetUeComponentCarrierManagerType(std::string type)
Set the type of Component Carrier Manager to be used by Ue devices.
Definition: lte-helper.cc:370
ObjectFactory m_fadingModelFactory
Factory of fading model object for both the downlink and uplink channels.
Definition: lte-helper.h:772
void EnableMacTraces(void)
Enable trace sinks for MAC layer.
Definition: lte-helper.cc:1529
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Instantiate subclasses of ns3::Object.
A base class which provides memory management and object aggregation.
Definition: object.h:88
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
This class is very useful when user needs to collect statistics from PDCP and RLC.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.