1 /**

     2  * \mainpage An Introduction to ns-3

     3  *

     4  * The ns-3 library is split across multiple modules:

     5  *     - core: located in src/core and contains a number of facilities which

     6  *       do not depend on any other module. Some of these facilities are

     7  *       OS-dependent.

     8  *     - simulator: located in src/simulator and contains event scheduling

     9  *       facilities.

    10  *     - common: located in src/common and contains facilities specific

    11  *       to network simulations but shared by pretty much every model

    12  *       of a network component.

    13  *

    14  * The "core" module contains:

    15  *    - a Functor class: ns3::Callback

    16  *    - an os-independent interface to get write-only access to a file: ns3::SystemFile

    17  *    - an os-independent interface to get access to the elapsed wall clock time: ns3:SystemWallClockMs

    18  *    - a class to register regression tests with the test manager: ns3::Test and ns3::TestManager

    19  *

    20  * The "simulator" module contains:

    21  *    - a time management class to hold a time and convert between various time units: ns3::Time

    22  *    - a scheduler base class used to implement new simulation event schedulers: 

    23  *      ns3::Scheduler and ns3::SchedulerFactory

    24  *    - a simulator class used to create, schedule and cancel events: ns3::Simulator

    25  *

    26  * The "common" module contains:

    27  *    - a packet class to create and manipulate simulation packets: ns3::Packet and ns3::Chunk

    28  *    - a trace container class to hold lists of trace sources: ns3::TraceContainer

    29  *    - a Pcap file serializer which can generate pcap files from simulation packets: ns3::PcapWriter

    30  */

    31 /**

    32  * \namespace ns3

    33  * \brief Every class exported by the ns3 library is enclosed in the

    34  * ns3 namespace.

    35  */