A Discrete-Event Network Simulator
API
epc-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-2013 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: Jaume Nin <jnin@cttc.es>
19  * Nicola Baldo <nbaldo@cttc.es>
20  * Manuel Requena <manuel.requena@cttc.es>
21  */
22 
23 #ifndef EPC_HELPER_H
24 #define EPC_HELPER_H
25 
26 #include <ns3/object.h>
27 #include <ns3/ipv4-address-helper.h>
28 #include <ns3/ipv6-address-helper.h>
29 #include <ns3/data-rate.h>
30 #include <ns3/epc-tft.h>
31 #include <ns3/eps-bearer.h>
32 
33 namespace ns3 {
34 
35 class Node;
36 class NetDevice;
37 class VirtualNetDevice;
38 class EpcSgwPgwApplication;
39 class EpcX2;
40 class EpcMme;
41 
51 class EpcHelper : public Object
52 {
53 public:
54 
58  EpcHelper ();
59 
63  virtual ~EpcHelper ();
64 
65  // inherited from Object
70  static TypeId GetTypeId (void);
71  virtual void DoDispose ();
72 
73 
82  virtual void AddEnb (Ptr<Node> enbNode, Ptr<NetDevice> lteEnbNetDevice, uint16_t cellId) = 0;
83 
90  virtual void AddUe (Ptr<NetDevice> ueLteDevice, uint64_t imsi) = 0;
91 
98  virtual void AddX2Interface (Ptr<Node> enbNode1, Ptr<Node> enbNode2) = 0;
99 
112  virtual uint8_t ActivateEpsBearer (Ptr<NetDevice> ueLteDevice, uint64_t imsi, Ptr<EpcTft> tft, EpsBearer bearer) = 0;
113 
114 
123  virtual Ptr<Node> GetPgwNode () = 0;
124 
133 
142 
143 
149 
155 
156 
157 };
158 
159 
160 
161 
162 } // namespace ns3
163 
164 #endif // EPC_HELPER_H
virtual Ipv4Address GetUeDefaultGatewayAddress()=0
Keep track of a set of IPv6 interfaces.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
virtual void AddEnb(Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)=0
Add an eNB to the EPC.
virtual Ptr< Node > GetPgwNode()=0
virtual Ipv6InterfaceContainer AssignUeIpv6Address(NetDeviceContainer ueDevices)=0
Assign IPv6 addresses to UE devices.
virtual Ipv6Address GetUeDefaultGatewayAddress6()=0
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:71
virtual void AddX2Interface(Ptr< Node > enbNode1, Ptr< Node > enbNode2)=0
Add an X2 interface between two eNB.
holds a vector of ns3::NetDevice pointers
virtual void AddUe(Ptr< NetDevice > ueLteDevice, uint64_t imsi)=0
Notify the EPC of the existence of a new UE which might attach at a later time.
virtual ~EpcHelper()
Destructor.
Definition: epc-helper.cc:41
EpcHelper()
Constructor.
Definition: epc-helper.cc:36
Base helper class to handle the creation of the EPC entities.
Definition: epc-helper.h:51
virtual void DoDispose()
Destructor implementation.
Definition: epc-helper.cc:57
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual uint8_t ActivateEpsBearer(Ptr< NetDevice > ueLteDevice, uint64_t imsi, Ptr< EpcTft > tft, EpsBearer bearer)=0
Activate an EPS bearer, setting up the corresponding S1-U tunnel.
virtual Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices)=0
Assign IPv4 addresses to UE devices.
Describes an IPv6 address.
Definition: ipv6-address.h:49
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
static TypeId GetTypeId(void)
Register this type.
Definition: epc-helper.cc:47
A base class which provides memory management and object aggregation.
Definition: object.h:87
a unique identifier for an interface.
Definition: type-id.h:58