author | Mitch Watrous <watrous@u.washington.edu> |
Tue, 17 May 2011 17:36:08 -0700 | |
changeset 7233 | be0d7443b4ff |
parent 7149 | 87514e0d866b |
child 7243 | ea3d634af9cf |
permissions | -rw-r--r-- |
2217 | 1 |
/** |
2 |
* @anchor modules_anchor |
|
3 |
* |
|
7233
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
4 |
* @defgroup constructs C++ Constructs Used by All Modules |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
5 |
* \brief These are C++ constructs defined by the modules. |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
6 |
* |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
7 |
* @defgroup constants Constants |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
8 |
* @brief Constants you can change |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
9 |
* |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
10 |
* @defgroup utils Utils |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
11 |
* @brief The utils directory is for various programs and scripts related |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
12 |
* to code coverage, test suites, style checking, and benchmarking. |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7149
diff
changeset
|
13 |
* |
7147
71adbc0422a5
Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents:
6736
diff
changeset
|
14 |
* @defgroup core Core |
71adbc0422a5
Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents:
6736
diff
changeset
|
15 |
* \brief The "core" module contains: |
2217 | 16 |
* - a time management class to hold a time and convert between various time units: ns3::Time |
17 |
* - a scheduler base class used to implement new simulation event schedulers: |
|
18 |
* ns3::Scheduler and ns3::SchedulerFactory |
|
19 |
* - a simulator class used to create, schedule and cancel events: ns3::Simulator |
|
20 |
* - a Functor class: ns3::Callback |
|
21 |
* - an os-independent interface to get access to the elapsed wall clock time: ns3::SystemWallClockMs |
|
22 |
* - 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
|
23 |
* - debugging facilities: \ref logging, \ref assert |
2217 | 24 |
* - \ref randomvariable |
2963
40a70a2e1b70
fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2891
diff
changeset
|
25 |
* - 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
|
26 |
* trace sources: ns3::ObjectBase |
2217 | 27 |
* - 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
|
28 |
* and dynamic object aggregation: ns3::Object |
2217 | 29 |
* - 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
|
30 |
* - 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
|
31 |
* in a simulation: ns3::Config. |
2217 | 32 |
* |
7147
71adbc0422a5
Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents:
6736
diff
changeset
|
33 |
* @defgroup network Network |
71adbc0422a5
Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents:
6736
diff
changeset
|
34 |
* The "network" module contains: |
2217 | 35 |
* - a packet class to create and manipulate simulation packets: |
36 |
* ns3::Packet, ns3::Header, and ns3::Trailer. This packet class |
|
37 |
* also supports per-packet ns3::Tag which are globs of data |
|
38 |
* which can be attached to any packet. |
|
39 |
* - a ns3::Node base class which should be subclassed by any new type of |
|
40 |
* network Node. |
|
41 |
* - models which abstract the MAC-layer from the IP layer protocols: |
|
42 |
* ns3::NetDevice and ns3::Channel. |
|
43 |
* - models which abstract the application-layer API: ns3::Application, |
|
44 |
* ns3::Socket, ns3::SocketFactory, and, ns3::Udp |
|
45 |
* |
|
7147
71adbc0422a5
Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents:
6736
diff
changeset
|
46 |
* @defgroup internet Internet |
2217 | 47 |
* |
7147
71adbc0422a5
Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents:
6736
diff
changeset
|
48 |
* The "internet" module contains: |
3260
8c0ab08144e6
bug 186: internet-node directory must be renamed to internet-stack
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3194
diff
changeset
|
49 |
* - an Ipv4 stack |
6736
fa6d53fb98a5
Update some stale documentation in doc/ directory
Tom Henderson <tomh@tomh.org>
parents:
6472
diff
changeset
|
50 |
* - an Ipv6 stack |
2217 | 51 |
* - 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
|
52 |
* - a UDP and a TCP implementation |
2217 | 53 |
* |
54 |
* @defgroup applications Applications |
|
55 |
* |
|
6472
54ce45443509
Mobility doxygen: all classes are documented and added to the mobility module. All public methods and fields should follow.
Pavel Boyko <boyko@iitp.ru>
parents:
6471
diff
changeset
|
56 |
* @defgroup mobility Mobility |
3183 | 57 |
*/ |