A Discrete-Event Network Simulator
API
lte-ue-net-device.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
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: Giuseppe Piro <g.piro@poliba.it>
18  * Nicola Baldo <nbaldo@cttc.es>
19  * Modified by:
20  * Danilo Abrignani <danilo.abrignani@unibo.it> (Carrier Aggregation - GSoC 2015)
21  * Biljana Bojovic <biljana.bojovic@cttc.es> (Carrier Aggregation)
22  */
23 
24 #ifndef LTE_UE_NET_DEVICE_H
25 #define LTE_UE_NET_DEVICE_H
26 
27 #include "ns3/component-carrier-ue.h"
28 #include "ns3/eps-bearer.h"
29 #include "ns3/event-id.h"
30 #include "ns3/lte-net-device.h"
31 #include "ns3/lte-phy.h"
32 #include "ns3/nstime.h"
33 #include "ns3/traced-callback.h"
34 
35 #include <map>
36 #include <vector>
37 
38 namespace ns3
39 {
40 
41 class Packet;
42 class PacketBurst;
43 class Node;
44 class LtePhy;
45 class LteUePhy;
46 class LteEnbNetDevice;
47 class LteUeMac;
48 class LteUeRrc;
49 class EpcUeNas;
50 class EpcTft;
51 class LteUeComponentCarrierManager;
52 
58 {
59  public:
64  static TypeId GetTypeId();
65 
67  ~LteUeNetDevice() override;
68  void DoDispose() override;
69 
70  // inherited from NetDevice
71  bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber) override;
72 
77  Ptr<LteUeMac> GetMac() const;
78 
83  Ptr<LteUeRrc> GetRrc() const;
84 
89  Ptr<LteUePhy> GetPhy() const;
90 
95  Ptr<EpcUeNas> GetNas() const;
96 
102 
107  uint64_t GetImsi() const;
108 
115  uint32_t GetDlEarfcn() const;
116 
123  void SetDlEarfcn(uint32_t earfcn);
124 
129  uint32_t GetCsgId() const;
130 
142  void SetCsgId(uint32_t csgId);
143 
149 
155 
160  void SetCcMap(std::map<uint8_t, Ptr<ComponentCarrierUe>> ccm);
161 
166  std::map<uint8_t, Ptr<ComponentCarrierUe>> GetCcMap();
167 
168  protected:
169  // inherited from Object
170  void DoInitialize() override;
171 
172  private:
174 
184  void UpdateConfig();
185 
187 
191 
192  uint64_t m_imsi;
193 
194  uint32_t m_dlEarfcn;
196  uint32_t m_csgId;
197 
198  std::map<uint8_t, Ptr<ComponentCarrierUe>> m_ccMap;
199 
200 }; // end of class LteUeNetDevice
201 
202 } // namespace ns3
203 
204 #endif /* LTE_UE_NET_DEVICE_H */
a polymophic address class
Definition: address.h:100
LteNetDevice provides basic implementation for all LTE network devices.
The LteUeNetDevice class implements the UE net device.
uint32_t m_csgId
the CSG ID
void DoInitialize() override
Initialize() implementation.
Ptr< LteUeRrc > m_rrc
the RRC
void SetCcMap(std::map< uint8_t, Ptr< ComponentCarrierUe >> ccm)
Set the ComponentCarrier Map for the UE.
uint64_t m_imsi
the IMSI
static TypeId GetTypeId()
Get the type ID.
void UpdateConfig()
Propagate attributes and configuration to sub-modules.
std::map< uint8_t, Ptr< ComponentCarrierUe > > m_ccMap
CC map.
Ptr< LteUeComponentCarrierManager > GetComponentCarrierManager() const
Get the componentn carrier manager.
Ptr< LteEnbNetDevice > GetTargetEnb()
Get the target eNB where the UE is registered.
Ptr< LteUeRrc > GetRrc() const
Get the RRC.
Ptr< EpcUeNas > GetNas() const
Get the NAS.
uint64_t GetImsi() const
Get the IMSI.
void SetCsgId(uint32_t csgId)
Enlist the UE device as a member of a particular CSG.
Ptr< LteUeComponentCarrierManager > m_componentCarrierManager
the component carrier manager
Ptr< LteUePhy > GetPhy() const
Get the Phy.
uint32_t m_dlEarfcn
downlink carrier frequency
void SetDlEarfcn(uint32_t earfcn)
Ptr< LteUeMac > GetMac() const
Get the MAC.
Ptr< EpcUeNas > m_nas
the NAS
bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override
std::map< uint8_t, Ptr< ComponentCarrierUe > > GetCcMap()
Get the ComponentCarrier Map for the UE.
void SetTargetEnb(Ptr< LteEnbNetDevice > enb)
Set the target eNB where the UE is registered.
void DoDispose() override
Destructor implementation.
uint32_t GetDlEarfcn() const
Ptr< LteEnbNetDevice > m_targetEnb
target ENB
uint32_t GetCsgId() const
Returns the CSG ID the UE is currently a member of.
bool m_isConstructed
is constructed?
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.