A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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/data-rate.h>
29 #include <ns3/epc-tft.h>
30 #include <ns3/eps-bearer.h>
31 
32 namespace ns3 {
33 
34 class Node;
35 class NetDevice;
36 class VirtualNetDevice;
37 class EpcSgwPgwApplication;
38 class EpcX2;
39 class EpcMme;
40 
48 class EpcHelper : public Object
49 {
50 public:
51 
55  EpcHelper ();
56 
60  virtual ~EpcHelper ();
61 
62  // inherited from Object
63  static TypeId GetTypeId (void);
64  virtual void DoDispose ();
65 
66 
75  virtual void AddEnb (Ptr<Node> enbNode, Ptr<NetDevice> lteEnbNetDevice, uint16_t cellId) = 0;
76 
83  virtual void AddUe (Ptr<NetDevice> ueLteDevice, uint64_t imsi) = 0;
84 
91  virtual void AddX2Interface (Ptr<Node> enbNode1, Ptr<Node> enbNode2) = 0;
92 
104  virtual void ActivateEpsBearer (Ptr<NetDevice> ueLteDevice, uint64_t imsi, Ptr<EpcTft> tft, EpsBearer bearer) = 0;
105 
106 
115  virtual Ptr<Node> GetPgwNode () = 0;
116 
125 
126 
132 
133 
134 };
135 
136 
137 
138 
139 } // namespace ns3
140 
141 #endif // EPC_HELPER_H
virtual Ipv4Address GetUeDefaultGatewayAddress()=0
holds a vector of std::pair of Ptr 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 void 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: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 existance of a new UE which might attach at a later time.
virtual ~EpcHelper()
Destructor.
Definition: epc-helper.cc:42
EpcHelper()
Constructor.
Definition: epc-helper.cc:37
Base helper class to handle the creation of the EPC entities.
Definition: epc-helper.h:48
virtual void DoDispose()
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: epc-helper.cc:57
virtual Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices)=0
Assign IPv4 addresses to UE devices.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
static TypeId GetTypeId(void)
Definition: epc-helper.cc:48
a base class which provides memory management and object aggregation
Definition: object.h:63
a unique identifier for an interface.
Definition: type-id.h:49