doc/modules
author Florian Westphal <fw@strlen.de>
Wed, 03 Sep 2008 23:24:59 +0200
changeset 3595 693faf7f4e9b
parent 3260 8c0ab08144e6
child 4673 36b78cddce4d
permissions -rw-r--r--
nsc: Fix build problem if gtk config store is disabled gtk config store pulled in libdl.so for us, so things fail to link of the config store isn't enabled. This makes nsc pull in libdl itself when its enabled.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
/**
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
 * @anchor modules_anchor
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
 * @defgroup simulator Simulator
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
 * The "simulator" module contains: 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
 *    - a time management class to hold a time and convert between various time units: ns3::Time 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
 *    - a scheduler base class used to implement new simulation event schedulers:       
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
 *      ns3::Scheduler and ns3::SchedulerFactory 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     9
 *    - a simulator class used to create, schedule and cancel events: ns3::Simulator
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    11
 * @defgroup core Core
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    12
 * \brief The "core" module contains:
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
 *    - a Functor class: ns3::Callback  
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
 *    - an os-independent interface to get access to the elapsed wall clock time: ns3::SystemWallClockMs 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
 *    - a class to register regression tests with the test manager: ns3::Test and ns3::TestManager
3194
79dba133b5f8 update RELEASE_NOTES and a few other files
Tom Henderson <tomh@tomh.org>
parents: 3183
diff changeset
    16
 *    - debugging facilities: \ref logging, \ref assert
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
 *    - \ref randomvariable
2963
40a70a2e1b70 fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2891
diff changeset
    18
 *    - a base class for objects which need to support per-instance "attributes" and
40a70a2e1b70 fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2891
diff changeset
    19
 *      trace sources: ns3::ObjectBase
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
 *    - a base class for objects which need to support reference counting
2963
40a70a2e1b70 fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2891
diff changeset
    21
 *      and dynamic object aggregation: ns3::Object
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
 *    - a smart-pointer class ns3::Ptr designed to work together with ns3::Object
2963
40a70a2e1b70 fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2891
diff changeset
    23
 *    - a configuration class used to set and control all attributes and trace sources
40a70a2e1b70 fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2891
diff changeset
    24
 *      in a simulation: ns3::Config.
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    26
 * @defgroup common Common
3183
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2963
diff changeset
    27
 * The "common" module contains: 
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    28
 *    - a packet class to create and manipulate simulation packets: 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    29
 *      ns3::Packet, ns3::Header,  and ns3::Trailer. This packet class 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
 *      also supports per-packet ns3::Tag which are  globs of data 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    31
 *      which can be attached to any packet.
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    33
 * @defgroup node Node
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    34
 * The "node" module contains:
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    35
 *    - a ns3::Node base class which should be subclassed by any new type of
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    36
 *      network Node.
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
 *    - models which abstract the MAC-layer from the IP layer protocols:
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
 *      ns3::NetDevice and ns3::Channel. 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
 *    - models which abstract the application-layer API: ns3::Application,
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
 *      ns3::Socket, ns3::SocketFactory, and, ns3::Udp
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    41
 * 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    42
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    43
 * @defgroup devices Devices
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    44
 *
3260
8c0ab08144e6 bug 186: internet-node directory must be renamed to internet-stack
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3194
diff changeset
    45
 * @defgroup internetStack InternetStack
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    46
 * 
3260
8c0ab08144e6 bug 186: internet-node directory must be renamed to internet-stack
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3194
diff changeset
    47
 * The "internet-stack" module contains:
8c0ab08144e6 bug 186: internet-node directory must be renamed to internet-stack
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3194
diff changeset
    48
 *    - an Ipv4 stack
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    49
 *    - an ARP module
3260
8c0ab08144e6 bug 186: internet-node directory must be renamed to internet-stack
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3194
diff changeset
    50
 *    - a UDP and a TCP implementation
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    51
 *    
2867
d63b525e3f80 Some doxygen work
Tom Henderson <tomh@tomh.org>
parents: 2217
diff changeset
    52
 * @defgroup helper Helpers
d63b525e3f80 Some doxygen work
Tom Henderson <tomh@tomh.org>
parents: 2217
diff changeset
    53
 * 
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    54
 * @defgroup applications Applications
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    56
 * @defgroup mobility Mobility
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    57
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    58
 * @defgroup routing Routing
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
 * @defgroup constants Constants
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    61
 * @brief Constants you can change
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    62
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    63
 * @defgroup contrib Contrib
3183
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2963
diff changeset
    64
 */