Comment at the top of ns-3.38/spec-extras/mobile-scenario.cc

// This program is designed to observe recurring handovers of UEs
// across nearby eNB cells. These eNBs are connected to the
// network core (SGW/PGW), which is then connected to a remote host
// in the Internet.
//
//    +---------------------------------------+
//    |                                       |
//    |                                       |
//  eNB1  1000,1250 ► 1750,1250  eNB2--------SGW-PGW-remote host
//            UE ______                       |
//               \    /                       |
//           ▲    \  /   ▼                    |
//                 \/                         |
//            1500, 1683                      |
//                                            |
//                eNB3------------------------+
//
// Application-wise, each one of the 6 UEs have 2 applications:
// 1) The first application (UdpEchoClient) sends a packet of 1000 bytes
//    every 10 milliseconds to a remote host
// 2) The second application (PacketSink) receives the incoming traffic
//    from the same remote host
//
// The remote host has the same setup with 2 applications, but targeting each
// of the individual UEs. The applications setup is meant to simulate two-way
// communication between client and server, which can get disrupted by the handover,
// reflecting on flow statistics.
//
// Flow statistics are collected via FlowMonitor and saved to the mobile-scenario.xml
// file for Netanim or custom tool consumption
//
// Default simulation time is of 5 minutes. Applications are configured to start
// at different times randomly obtained ranging from 1 second and 1.9 seconds
//
//
// Node IDs | Description | IP Addresses (use)
// ---------+-------------+--------------------------------------------------
//        0 | PGW         | 1.0.0.1 (Internet),
//          |             | 14.0.0.5 (PGW-SGW),
//          |             | 7.0.0.1 (GPRS Tunneling Protocol-GTP entry point)
//----------+-------------+--------------------------------------------------
//        1 | SGW         | 14.0.0.06 (PGW-SGW),
//          |             | 13.0.0.06 (MME-SGW),
//          |             | 10.0.0.06 (X1),
//          |             | 10.0.0.10 (X1),
//          |             | 10.0.0.14 (X1),
// ---------+-------------+--------------------------------------------------
//        2 | MME         | 13.0.0.5 (MME-SGW)
// ---------+-------------+--------------------------------------------------
//        3 | Remote host | 1.0.0.2 (Internet)
// ---------+-------------+--------------------------------------------------
//        4 | eNB         | 10.0.0.05 (X1), 12.0.0.05 (X2), 12.0.0.09 (X2)
// ---------+-------------+--------------------------------------------------
//        5 | eNB         | 10.0.0.09 (X1), 12.0.0.06 (X2), 12.0.0.13 (X2)
// ---------+-------------+--------------------------------------------------
//        6 | eNB         | 10.0.0.13 (X1), 12.0.0.10 (X2), 12.0.0.14 (X2)
// ---------+-------------+--------------------------------------------------
//        7 | UE          | 7.0.0.2
// ---------+-------------+--------------------------------------------------
//        8 | UE          | 7.0.0.3
// ---------+-------------+--------------------------------------------------
//        9 | UE          | 7.0.0.4
// ---------+-------------+--------------------------------------------------
//       10 | UE          | 7.0.0.5
// ---------+-------------+--------------------------------------------------
//       11 | UE          | 7.0.0.6
// ---------+-------------+--------------------------------------------------
//       12 | UE          | 7.0.0.7
//
// Program Options:
// ---------------
//    --simTimeMinutes:       simulation stop time [+5min]
//
// How to run:
// ------------
//     ./ns3 run 'mobile-scenario --simTimeMinutes=10'