author | Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
Mon, 02 Oct 2006 14:41:00 +0200 | |
changeset 112 | abd79142a0e1 |
parent 94 | 6aabc116c7c7 |
child 398 | 3b725b90db89 |
permissions | -rw-r--r-- |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1 |
/** |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
2 |
* \mainpage An Introduction to ns-3 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
3 |
* |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
4 |
* The ns-3 library is split across multiple modules: |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
5 |
* - core: located in src/core and contains a number of facilities which |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
6 |
* do not depend on any other module. Some of these facilities are |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
7 |
* OS-dependent. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
8 |
* - simulator: located in src/simulator and contains event scheduling |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
9 |
* facilities. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
10 |
* - common: located in src/common and contains facilities specific |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
11 |
* to network simulations but shared by pretty much every model |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
12 |
* of a network component. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
13 |
* |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
14 |
* The "core" module contains: |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
15 |
* - a Functor class: ns3::Callback |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
16 |
* - an os-independent interface to get write-only access to a file: ns3::SystemFile |
66 | 17 |
* - an os-independent interface to get access to the elapsed wall clock time: ns3::SystemWallClockMs |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
18 |
* - a class to register regression tests with the test manager: ns3::Test and ns3::TestManager |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
19 |
* |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
20 |
* The "simulator" module contains: |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
21 |
* - a time management class to hold a time and convert between various time units: ns3::Time |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
22 |
* - a scheduler base class used to implement new simulation event schedulers: |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
23 |
* ns3::Scheduler and ns3::SchedulerFactory |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
24 |
* - a simulator class used to create, schedule and cancel events: ns3::Simulator |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
25 |
* |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
26 |
* The "common" module contains: |
112
abd79142a0e1
remove reference to Chunk
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
94
diff
changeset
|
27 |
* - a packet class to create and manipulate simulation packets: ns3::Packet, ns3::Header, |
abd79142a0e1
remove reference to Chunk
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
94
diff
changeset
|
28 |
* and ns3::Trailer |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
29 |
* - a trace container class to hold lists of trace sources: ns3::TraceContainer |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
30 |
* - a Pcap file serializer which can generate pcap files from simulation packets: ns3::PcapWriter |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
31 |
*/ |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
32 |
/** |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
33 |
* \namespace ns3 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
34 |
* \brief Every class exported by the ns3 library is enclosed in the |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
35 |
* ns3 namespace. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
36 |
*/ |
94
6aabc116c7c7
add Constants section to doxygen documentation
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
66
diff
changeset
|
37 |
/** |
6aabc116c7c7
add Constants section to doxygen documentation
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
66
diff
changeset
|
38 |
* \defgroup constants |
6aabc116c7c7
add Constants section to doxygen documentation
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
66
diff
changeset
|
39 |
* \brief Constants you can change |
6aabc116c7c7
add Constants section to doxygen documentation
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
66
diff
changeset
|
40 |
*/ |