doc/modules
changeset 2217 0b4567d545de
child 2867 d63b525e3f80
equal deleted inserted replaced
2216:9c209295b0b1 2217:0b4567d545de
       
     1 /**
       
     2  * @anchor modules_anchor
       
     3  *
       
     4  * @defgroup simulator Simulator
       
     5  * The "simulator" module contains: 
       
     6  *    - a time management class to hold a time and convert between various time units: ns3::Time 
       
     7  *    - a scheduler base class used to implement new simulation event schedulers:       
       
     8  *      ns3::Scheduler and ns3::SchedulerFactory 
       
     9  *    - a simulator class used to create, schedule and cancel events: ns3::Simulator
       
    10  *
       
    11  * @defgroup core Core
       
    12  * \brief The "core" module contains:
       
    13  *    - a Functor class: ns3::Callback  
       
    14  *    - an os-independent interface to get access to the elapsed wall clock time: ns3::SystemWallClockMs 
       
    15  *    - a class to register regression tests with the test manager: ns3::Test and ns3::TestManager
       
    16  *    - debugging facilities: \ref logging, \ref assert, \ref error
       
    17  *    - \ref randomvariable
       
    18  *    - \ref config
       
    19  *    - a base class for objects which need to support reference counting
       
    20  *      and QueryInterface: ns3::Object and ns3::InterfaceId 
       
    21  *    - a set of low-level trace facilities integrated in the ns3::Object system: \ref tracing
       
    22  *    - a ns3::ComponentManager which can be used to manage the creation
       
    23  *      of any object which derives from ns3::Object through an ns3::ClassId 
       
    24  *    - a smart-pointer class ns3::Ptr designed to work together with ns3::Object
       
    25  *
       
    26  * @defgroup common Common
       
    27  * The "core" module contains: 
       
    28  *    - a packet class to create and manipulate simulation packets: 
       
    29  *      ns3::Packet, ns3::Header,  and ns3::Trailer. This packet class 
       
    30  *      also supports per-packet ns3::Tag which are  globs of data 
       
    31  *      which can be attached to any packet.
       
    32  *
       
    33  * @defgroup node Node
       
    34  * The "node" module contains:
       
    35  *    - a ns3::Node base class which should be subclassed by any new type of
       
    36  *      network Node.
       
    37  *    - models which abstract the MAC-layer from the IP layer protocols:
       
    38  *      ns3::NetDevice and ns3::Channel. 
       
    39  *    - models which abstract the application-layer API: ns3::Application,
       
    40  *      ns3::Socket, ns3::SocketFactory, and, ns3::Udp
       
    41  * 
       
    42  *
       
    43  * @defgroup devices Devices
       
    44  * The "devices" module contains:
       
    45  *    - a PointToPoint MAC device: ns3::PointToPointNetDevice, ns3::PointToPointChannel,
       
    46  *      and ns3::PointToPointTopology.
       
    47  *
       
    48  * @defgroup internetNode InternetNode
       
    49  * 
       
    50  * The "internet-node" module contains a set of classes which implement the
       
    51  * APIs defined in the "node" module:
       
    52  *    - an Ipv4/Udp stack with socket support 
       
    53  *    - an ARP module
       
    54  *    - an InternetNode class which is a Node subclass.
       
    55  *    
       
    56  * @defgroup applications Applications
       
    57  *
       
    58  * @defgroup mobility Mobility
       
    59  *
       
    60  * @defgroup routing Routing
       
    61  *
       
    62  * @defgroup constants Constants
       
    63  * @brief Constants you can change
       
    64  *
       
    65  * @defgroup contrib Contrib
       
    66  */
       
    67