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 EpcX2;
39 
49 class EpcHelper : public Object
50 {
51 public:
52 
56  EpcHelper ();
57 
61  virtual ~EpcHelper ();
62 
63  // inherited from Object
68  static TypeId GetTypeId (void);
69  virtual void DoDispose ();
70 
71 
80  virtual void AddEnb (Ptr<Node> enbNode, Ptr<NetDevice> lteEnbNetDevice, std::vector<uint16_t> cellIds) = 0;
81 
88  virtual void AddUe (Ptr<NetDevice> ueLteDevice, uint64_t imsi) = 0;
89 
96  virtual void AddX2Interface (Ptr<Node> enbNode1, Ptr<Node> enbNode2) = 0;
97 
106  virtual void AddS1Interface (Ptr<Node> enb, Ipv4Address enbAddress, Ipv4Address sgwAddress, std::vector<uint16_t> cellIds) = 0;
107 
108 
121  virtual uint8_t ActivateEpsBearer (Ptr<NetDevice> ueLteDevice, uint64_t imsi, Ptr<EpcTft> tft, EpsBearer bearer) = 0;
122 
123 
129  virtual Ptr<Node> GetSgwNode () const = 0;
130 
131 
139  virtual Ptr<Node> GetPgwNode () const = 0;
140 
149 
158 
159 
165 
171 
172 
173 };
174 
175 
176 
177 
178 } // namespace ns3
179 
180 #endif // EPC_HELPER_H
Base helper class to handle the creation of the EPC entities.
Definition: epc-helper.h:50
virtual Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices)=0
Assign IPv4 addresses to UE devices.
virtual ~EpcHelper()
Destructor.
Definition: epc-helper.cc:41
virtual Ptr< Node > GetSgwNode() const =0
Get the SGW node.
EpcHelper()
Constructor.
Definition: epc-helper.cc:36
virtual void AddX2Interface(Ptr< Node > enbNode1, Ptr< Node > enbNode2)=0
Add an X2 interface between two eNB.
virtual void DoDispose()
Destructor implementation.
Definition: epc-helper.cc:57
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 void AddEnb(Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, std::vector< uint16_t > cellIds)=0
Add an eNB to the EPC.
static TypeId GetTypeId(void)
Register this type.
Definition: epc-helper.cc:47
virtual Ipv6InterfaceContainer AssignUeIpv6Address(NetDeviceContainer ueDevices)=0
Assign IPv6 addresses to UE devices.
virtual Ptr< Node > GetPgwNode() const =0
Get the PGW node.
virtual Ipv4Address GetUeDefaultGatewayAddress()=0
virtual void AddS1Interface(Ptr< Node > enb, Ipv4Address enbAddress, Ipv4Address sgwAddress, std::vector< uint16_t > cellIds)=0
Add an S1 interface between an eNB and a SGW.
virtual Ipv6Address GetUeDefaultGatewayAddress6()=0
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.
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:92
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Describes an IPv6 address.
Definition: ipv6-address.h:50
Keep track of a set of IPv6 interfaces.
holds a vector of ns3::NetDevice pointers
A base class which provides memory management and object aggregation.
Definition: object.h:88
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.