Binary file doc/WimaxArchitecture.png has changed
--- a/doc/manual/applications.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/applications.texi Fri Dec 10 15:22:36 2010 +0100
@@ -1,5 +1,5 @@
-@node Applications
-@chapter Applications
+@node Applications Overview
+@chapter Applications Overview
@cartouche
Placeholder chapter
--- a/doc/manual/callbacks.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/callbacks.texi Fri Dec 10 15:22:36 2010 +0100
@@ -11,8 +11,8 @@
* Callbacks Background::
* Using the Callback API::
* Bound Callbacks::
+* Traced Callbacks::
* Callback locations in ns-3::
-* Traced Callbacks::
* Implementation details::
@end menu
@@ -597,7 +597,7 @@
@cartouche
Placeholder subsection
@end cartouche
-@section Callback locations in @command{ns-3}
+
@node Callback locations in ns-3
@section Callback locations in @command{ns-3}
--- a/doc/manual/csma.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/csma.texi Fri Dec 10 15:22:36 2010 +0100
@@ -6,6 +6,8 @@
@menu
* Overview of the CSMA model::
+* CSMA Channel Model::
+* CSMA Net Device Model::
* Using the CsmaNetDevice::
* CSMA Tracing::
@end menu
@@ -88,6 +90,7 @@
reception of a packet by the net device in order to forward the packet up
the protocol stack.
+@node CSMA Channel Model
@section CSMA Channel Model
The class CsmaChannel models the actual transmission medium.
@@ -157,6 +160,7 @@
@item Delay: The speed of light transmission delay for the channel.
@end itemize
+@node CSMA Net Device Model
@section CSMA Net Device Model
The CSMA network device appears somewhat like an Ethernet device. The
--- a/doc/manual/emulation.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/emulation.texi Fri Dec 10 15:22:36 2010 +0100
@@ -1,5 +1,5 @@
-@node Emulation
-@chapter Emulation
+@node Emulation Overview
+@chapter Emulation Overview
ns-3 has been designed for integration into testbed and virtual machine
environments. We have addressed this need by providing two kinds of
--- a/doc/manual/manual.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/manual.texi Fri Dec 10 15:22:36 2010 +0100
@@ -88,6 +88,25 @@
@menu
* Organization::
+* Core::
+* Node and NetDevices::
+* Emulation::
+* Internet Models::
+* Applications::
+* Support::
+@end menu
+
+@setchapternewpage odd
+@headings off
+@everyheading @thischapter @| @| ns-3 manual
+@everyfooting ns-3 @| @thispage @| @today
+@include organization.texi
+
+@node Core
+@chapter Core
+
+@lowersections
+@menu
* Random variables::
* Callbacks::
* Object model::
@@ -100,38 +119,8 @@
* Packets::
* Helpers::
* Python::
-* Node and NetDevices::
-* Simple NetDevice::
-* PointToPoint NetDevice::
-* CSMA NetDevice::
-* Wifi NetDevice::
-* Mesh NetDevice::
-* Bridge NetDevice::
-* Wimax NetDevice::
-* Emulation::
-* Emu NetDevice::
-* Tap NetDevice::
-* Sockets APIs::
-* Internet Stack::
-* IPv4::
-* IPv6::
-* Routing overview::
-* TCP::
-* Applications::
-* Flow Monitor::
-* Animation::
-* Statistics::
-* Creating a new ns-3 model::
-* Troubleshooting::
@end menu
-@setchapternewpage odd
-@headings off
-@everyheading @thischapter @| @| ns-3 manual
-@everyfooting ns-3 @| @thispage @| @today
-@include organization.texi
-
-@unnumbered Part 1: ns-3 core
@setchapternewpage off
@include random.texi
@setchapternewpage odd
@@ -146,8 +135,23 @@
@include packets.texi
@include helpers.texi
@include python.texi
+@raisesections
-@unnumbered Part 2: Nodes and NetDevices
+@node Node and NetDevices
+@chapter Node and NetDevices
+
+@lowersections
+@menu
+* Node and NetDevices Overview::
+* Simple NetDevice::
+* PointToPoint NetDevice::
+* CSMA NetDevice::
+* Wifi NetDevice::
+* Mesh NetDevice::
+* Bridge NetDevice::
+* Wimax NetDevice::
+@end menu
+
@setchapternewpage off
@include node.texi
@setchapternewpage odd
@@ -158,15 +162,38 @@
@include mesh.texi
@include bridge.texi
@include wimax.texi
+@raisesections
-@unnumbered Part 3: Emulation
+@node Emulation
+@chapter Emulation
+
+@menu
+* Emulation Overview::
+* Emu NetDevice::
+* Tap NetDevice::
+@end menu
+
+@lowersections
@setchapternewpage off
@include emulation.texi
@setchapternewpage odd
@include emu.texi
@include tap.texi
+@raisesections
-@unnumbered Part 4: Internet Models
+@node Internet Models
+@chapter Internet Models
+
+@menu
+* Sockets APIs::
+* Internet Stack::
+* IPv4::
+* IPv6::
+* Routing overview::
+* TCP::
+@end menu
+
+@lowersections
@setchapternewpage off
@include sockets.texi
@setchapternewpage odd
@@ -175,13 +202,33 @@
@include ipv6.texi
@include routing.texi
@include tcp.texi
+@raisesections
-@unnumbered Part 5: Applications
+@node Applications
+@chapter Applications
+
+@menu
+* Applications Overview::
+@end menu
+
+@lowersections
@setchapternewpage off
@include applications.texi
@setchapternewpage odd
+@raisesections
-@unnumbered Part 6: Support
+@node Support
+@chapter Support
+
+@menu
+* Flow Monitor::
+* Animation::
+* Statistics::
+* Creating a new ns-3 model::
+* Troubleshooting::
+@end menu
+
+@lowersections
@setchapternewpage off
@include flow-monitor.texi
@setchapternewpage odd
@@ -189,6 +236,7 @@
@include statistics.texi
@include new-models.texi
@include troubleshoot.texi
+@raisesections
@printindex cp
--- a/doc/manual/new-models.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/new-models.texi Fri Dec 10 15:22:36 2010 +0100
@@ -6,6 +6,7 @@
* Scaffolding::
* Initial Implementation::
* Adding-a-sample-script::
+* Add subclass::
* Build-core-functions-and-unit-tests::
@end menu
@@ -533,6 +534,7 @@
node n3. Next, we return to the error model to add in a subclass
that performs more interesting error modeling.
+@node Add subclass
@section Add subclass
The trivial base class ErrorModel does not do anything interesting,
--- a/doc/manual/node.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/node.texi Fri Dec 10 15:22:36 2010 +0100
@@ -1,7 +1,11 @@
-@node Node and NetDevices
-@chapter Node and NetDevices
+@node Node and NetDevices Overview
+@chapter Node and NetDevices Overview
@anchor{chap:Node}
+@menu
+* NodeList::
+@end menu
+
This chapter describes how ns-3 nodes are put together, and provides
a walk-through of how packets traverse an internet-based Node.
@@ -102,6 +106,7 @@
@end verbatim
and likewise for Ipv6, ARP, etc.
+@node NodeList
@section NodeList
Every Node created is automatically added to the ns-3 @code{NodeList}.
--- a/doc/manual/objects.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/objects.texi Fri Dec 10 15:22:36 2010 +0100
@@ -6,7 +6,6 @@
@chapter Object model
@menu
-* Object model::
* Object-oriented behavior::
* Object base classes::
* Memory management and class Ptr::
--- a/doc/manual/point-to-point.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/point-to-point.texi Fri Dec 10 15:22:36 2010 +0100
@@ -6,6 +6,7 @@
@menu
* Overview of the PointToPoint model::
+* Point-to-Point Channel Model::
* Using the PointToPointNetDevice::
* PointToPoint Tracing::
@end menu
@@ -58,6 +59,7 @@
model." This is an ErrorModel object that is used to simulate data
corruption on the link.
+@node Point-to-Point Channel Model
@section Point-to-Point Channel Model
The point to point net devices are connected via an
--- a/doc/manual/wimax.texi Fri Dec 10 13:47:30 2010 +0100
+++ b/doc/manual/wimax.texi Fri Dec 10 15:22:36 2010 +0100
@@ -34,6 +34,8 @@
* Wimax Tracing::
* Wimax MAC model::
* WimaxChannel and WimaxPhy models::
+* Channel model::
+* Physical model::
@end menu
@node Scope of the model
@@ -460,6 +462,7 @@
It supports all the seven modulation and coding schemes specified by Wireless
MAN-OFDM. It is composed of two parts: the channel model and the physical model.
+@node Channel model
@section Channel model
The channel model we propose is implemented by the @code{class SimpleOFDMWimaxChannel} which
@@ -472,6 +475,7 @@
entities according to their 3D coordinates. The delay is computed as @code{delay = distance/C}, where C
is the speed of the light.
+@node Physical model
@section Physical model
The physical layer performs two main operations: (i) It receives a burst from a channel and forwards it to the
