From 9dd092a3745ac6fe92cbfbce68e4e61961ed6af4 Mon Sep 17 00:00:00 2001 From: Nicola Baldo Date: Mon, 25 Nov 2013 12:44:34 +0100 Subject: [PATCH] updated LTE docs for abstract EpcHelper --- src/lte/doc/source/lte-design.rst | 8 ++++++-- src/lte/doc/source/lte-user.rst | 27 +++++++++++++++++---------- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/src/lte/doc/source/lte-design.rst b/src/lte/doc/source/lte-design.rst index 2ddef281f..8e1de4b57 100644 --- a/src/lte/doc/source/lte-design.rst +++ b/src/lte/doc/source/lte-design.rst @@ -3453,9 +3453,13 @@ various components. These objects are: * ``LteHelper``, which takes care of the configuration of the LTE radio access network, as well as of coordinating the setup and release of - EPS bearers + EPS bearers. The ``LteHelper`` class provides both the API + definition and its implementation. * ``EpcHelper``, which takes care of the configuration of the Evolved - Packet Core + Packet Core. The ``EpcHelper`` class is an abstract base class + which only provides the API definition; the implementation is delegated + to child classes in order to allow for different EPC network + models. It is possible to create a simple LTE-only simulations by using ``LteHelper`` alone, or to create complete LTE-EPC simulations by diff --git a/src/lte/doc/source/lte-user.rst b/src/lte/doc/source/lte-user.rst index ff34d6c6e..a1796ef74 100644 --- a/src/lte/doc/source/lte-user.rst +++ b/src/lte/doc/source/lte-user.rst @@ -263,7 +263,7 @@ You can try also with other LTE and EPC objects, like this:: ./waf --run lena-simple --command-template="%s --PrintAttributes=ns3::LteEnbMac" ./waf --run lena-simple --command-template="%s --PrintAttributes=ns3::LteEnbPhy" ./waf --run lena-simple --command-template="%s --PrintAttributes=ns3::LteUePhy" - ./waf --run lena-simple --command-template="%s --PrintAttributes=ns3::EpcHelper" + ./waf --run lena-simple --command-template="%s --PrintAttributes=ns3::PointToPointEpcHelper" @@ -776,11 +776,18 @@ you will be able to use the regular ns-3 applications and sockets over IPv4 over LTE, and also to connect an LTE network to any other IPv4 network you might have in your simulation. -First of all, in your simulation program you need to create two -helpers:: +First of all, in addition to ``LteHelper`` that we already introduced +in :ref:`sec-basic-simulation-program`, you need to use an additional +``EpcHelper`` class, which will take care of creating the EPC entities and +network topology. Note that you can't use ``EpcHelper`` directly, as +it is an abstract base class; instead, you need to use one of its +child classes, which provide different EPC topology implementations. In +this example we will consider ``PointToPointEpcHelper``, which +implements an EPC based on point-to-point links. To use it, you need +first to insert this code in your simulation program:: Ptr lteHelper = CreateObject (); - Ptr epcHelper = CreateObject (); + Ptr epcHelper = CreateObject (); Then, you need to tell the LTE helper that the EPC will be used:: @@ -801,11 +808,11 @@ created will have the ``EpsBearerToRlcMapping`` attribute set to the default; otherwise, the attribute won't be changed (e.g., if you changed the default to ``RLC_AM_ALWAYS``, it won't be touched). -It is to be noted that, upon construction, the ``EpcHelper`` will also -create and configure the PGW node. Its configuration in particular -is very complex, and hence is done automatically by the Helper. Still, -it is allowed to access the PGW node in order to connect it to other -IPv4 network (e.g., the internet). Here is a very simple example about +It is to be noted that the ``EpcHelper`` will also automatically +create the PGW node and configure it so that it can properly handle +traffic from/to the LTE radio access network. Still, +you need to add some explicit code to connect the PGW to other +IPv4 networks (e.g., the internet). Here is a very simple example about how to connect a single remote host to the PGW via a point-to-point link:: @@ -833,7 +840,7 @@ link:: It's important to specify routes so that the remote host can reach LTE UEs. One way of doing this is by exploiting the fact that the -EpcHelper will by default assign to LTE UEs an IP address in the +``PointToPointEpcHelper`` will by default assign to LTE UEs an IP address in the 7.0.0.0 network. With this in mind, it suffices to do:: Ipv4StaticRoutingHelper ipv4RoutingHelper;