From ce1db5600d0bfd3ff199343ebf5edc33d42b0173 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Fri, 21 Sep 2012 16:27:45 -0700 Subject: [PATCH] document the example --- .../examples/bonnmotion-ns2-example.cc | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/src/mobility/examples/bonnmotion-ns2-example.cc b/src/mobility/examples/bonnmotion-ns2-example.cc index 71ee8d5a1..2a63d7aa8 100644 --- a/src/mobility/examples/bonnmotion-ns2-example.cc +++ b/src/mobility/examples/bonnmotion-ns2-example.cc @@ -17,6 +17,29 @@ * */ +/* + * Example program using a ns-2-formatted mobility trace generated + * by the BonnMotion mobility framework. + * + * With the provided tracefile (bonnmotion.ns_movements), the movements of + * one node are simulated for 1000 seconds. There are a few other files + * that provide metadata about the mobility: + * - src/mobility/examples/bonnmotion.ns_params + * - src/mobility/examples/bonnmotion.params + * + * These files are documented in the BonnMotion documentation. + * + * It is important to remember that the trace file dictates how many nodes + * (in this case, one) and how long (in this case, 1000 seconds) that the + * ns-3 program should use. If you want to change the mobility pattern, + * number of nodes, or duration, you need to use BonnMotion or another + * tool to generate a new trace. + * + * Finally, note that you can visualize this program using the pyviz + * visualizer: + * ./waf --run bonnmotion-ns2-example --vis + */ + #include "ns3/core-module.h" #include "ns3/mobility-module.h"