Difference between revisions of "NetAnim"

From Nsnam
Jump to: navigation, search
(In General)
 
(142 intermediate revisions by 2 users not shown)
Line 1: Line 1:
NetAnim is an animator based on the multi-platform Qt 4 toolkit.
+
{{TOC}}
NetAnim currently animates the simulation using an XML trace file collected during simulation.
+
 
 +
NetAnim is an offline animator based on the Qt toolkit.
 +
It currently animates the simulation using an XML trace file collected during simulation. The first version was developed by George F Riley.  
  
 
[[Image:NetAnim3.png|thumb|The NetAnim GUI]]  
 
[[Image:NetAnim3.png|thumb|The NetAnim GUI]]  
  
 +
== NetAnim Versions ==
 +
* 3.108 bundled with ns-3.27
 +
[[ NetAnim 3.108 ]]
  
== Feature-set in NetAnim 3.0 ==
+
* 3.107
** Animate wired-links and wireless-links based simulations
+
[[ NetAnim 3.107 ]]
** Complete redesign using the QGraphics framework
+
** Packet statistics with filter
+
** Node position statistics with node trajectory plotting
+
** Improved window re-sizing and zooming
+
 
+
== Prerequisites ==
+
# mercurial
+
# QT4 development packages (recommended version 4.7)
+
 
+
=== Debian/Ubuntu Linux distribution:===
+
# apt-get install mercurial
+
# apt-get install qt4-dev-tools
+
 
+
=== Red Hat/Fedora based distribution:===
+
# yum install mercurial
+
# yum install qt4
+
# yum install qt4-devel
+
 
+
=== Mac/OSX ===
+
# mercurial
+
# Qt4 : Install Qt4 (including Qt Creator if possible) from http://qt.nokia.com/downloads/
+
 
+
== Downloading NetAnim ==
+
* NetAnim 3.0:
+
 
+
hg clone http://code.nsnam.org/jabraham3/netanim
+
 
+
* NetAnim 2.0:
+
Go to this link [[NetAnim2]]
+
 
+
* NetAnim 1.0:
+
Go to this link [[NetAnim 1.0]]
+
 
+
== Building NetAnim==
+
NetAnim uses a QT4 build tool called qmake. Only qmake version 4.7 is supported
+
Please read the [[#Prerequisites]] before proceeding
+
 
+
=== In General ===
+
 
+
cd netanim
+
make clean
+
qmake NetAnim.pro   
+
make
+
 
+
'''Note: qmake could be "qmake-qt4" in some systems
+
'''
+
 
+
This should create an executable named "NetAnim" in the same directory
+
 
+
== Using ns3::AnimationInterface to generate Animation trace files==
+
 
+
The NetAnim application requires a custom trace file for animation. 
+
This trace file is created by [http://www.nsnam.org/doxygen/classns3_1_1_animation_interface.html AnimationInterface] in ns-3.  
+
# Model is at: src/netanim/model
+
# Examples are at src/netanim/examples
+
 
+
NetAnim 2.0 supports only reading XML trace files.
+
 
+
NetAnim 1.0 can read only Non-XML traces.
+
 
+
AnimationInterface as of ns-3.12 generates only non-XML trace files by default.
+
To generate XML trace files, use [http://www.nsnam.org/doxygen/classns3_1_1_animation_interface.html#ae8612e0b82dd1166add6e959d6c5e5a8 void ns3::AnimationInterface::SetXMLOutput()] prior to StartAnimation. See the examples under "src/netanim/examples"
+
 
+
=== Recommended set of steps ===
+
Here is the recommended set of steps for generating XML Animation traces.They must be applied before the "Simulation::Run" statement.
+
 
+
'''NOTE: A node must have an associated mobility model in-order to be displayed on the animation.
+
This applies for both stationary and mobile nodes (See notes below) '''
+
  0. Ensure that your wscript includes the "netanim" module. Example as in: src/netanim/examples/wscript. Also include the header [#include "ns3/netanim-module.h"] in your test program
+
 
+
For ns-3 version upto ns-3.12
+
  1. AnimationInterface anim;
+
  2. anim.SetOutputFile ("animation.xml");
+
  3. anim.SetXMLOutput ();
+
  4. anim.SetMobilityPollInterval (Seconds (1));
+
  5. anim.StartAnimation ();
+
 
+
where
+
  1. Create an AnimationInterface object
+
  2. Set the trace output file name
+
  3. Enable XML output (Only when using NetAnim 2.0). If this statement is not used, the AnimationInterface generates traces which are non-XML and can only be
+
      read by NetAnim 1.0
+
  4. This statement is optional. It records the position of the nodes every 1 second. NOTE: Setting a low value may result in large XML files.
+
    If your topology is expected to be stationary, it will be good to set it to a very large value (so that polling occurs rarely).
+
  5. Start recording traces. StartAnimation and other AnimationInterface methods should be called before "Simulator::Run()"
+
 
+
For ns-3 version after ns-3.12
+
  1. AnimationInterface anim ("animation.xml")
+
  2. anim.SetMobilityPollInterval (Seconds (1));[OPTIONAL]
+
 
+
=== Running an Example File ===
+
 
+
The netanim example files are located under "src/netanim/examples"
+
 
+
  ./waf --run "dumbbell-animation --nLeftLeaf=5 --nRightLeaf=5 --animFile=dumbbell.xml"
+
  ./waf --run "grid-animation --xSize=5 --ySize=5 --animFile=grid.xml"
+
 
+
 
+
=== Setting the location of nodes ===
+
NetAnim requires a location to be assigned to each Node, in-order to be shown on the animation.
+
 
+
==== For stationary nodes: ====
+
* You should assign the ConstantPositionMobilityModel. Constant Position is a kind of mobility.
+
Here is an example:
+
 
+
  1. Ptr<Node> n = nodecontainer.Get (1);
+
  2. Ptr<ConstantPositionMobilityModel> Loc =  n->GetObject<ConstantPositionMobilityModel> ();
+
  3. if (Loc == 0)
+
        {
+
  4.    Loc = CreateObject<ConstantPositionMobilityModel> ();
+
  5.    n->AggregateObject (Loc);
+
        }
+
  6. Vector vec (10, 20, 0);
+
  7. Loc->SetPosition (vec);
+
 
+
where
+
 
+
  1. Get a Ptr to Node from the node container
+
  2. Get the aggregated ConstantPositionMobilityModel object from the node
+
  3. If Loc ==0 , it indicates that this node is not aggregated with a mobility model.So we have to aggregate one.
+
  4. Create a ConstantPositionMobilityModel object and assign it to Loc
+
  5. Aggregate the mobility model "Loc" to the node
+
  6. Create a position vector with 3-d co-ordinates  x= 10, y= 20, z=0
+
  7. Set the position vector to the mobility model
+
 
+
==== For mobile nodes ====
+
* You should assign any suitable Mobility model.
+
The examples for these are found in places such as src/mobility/examples or examples/routing/manet-routing-compare.cc etc
+
 
+
== Understanding the XML trace file format ==
+
 
+
The ns3::AnimationInterface class is responsible for the creation of the xml trace files. Currently, in basic-mode, AnimationInterface records the position of the nodes at every periodic interval. This interval is 200 ms by default. This will become more efficient in future releases. This has the potential to cause
+
a. Slowness in simulation
+
b. Large XML trace files
+
 
+
Some ways to get around this is to identify if your topology has
+
# only stationary nodes and hence no mobility
+
# or slow-moving nodes
+
 
+
If the above is the case you should use AnimationInterface::SetMobilityPollInterval to set the poll interval to a high value.
+
 
+
=== Parts of the XML ===
+
The XML trace files has the following main sections
+
# Topology
+
## Nodes
+
## Links
+
# packets (packets over wired-links)
+
# wpackets (packets over wireless-links.LTE not supported)
+
 
+
=== XML tags ===
+
Nodes are identified by their unique Node id.
+
The XML begins with the "information" element describing the rest of the elements
+
 
+
==== <anim> element ====
+
This is the XML root element. All other elements fall within this element
+
  Attributes are:
+
    lp = Logical Processor Id (Used for distributed simulations only)
+
 
+
====  <topology> element ====
+
This elements contains the Node and Link elements.It describes, the
+
co-ordinates of the canvas used for animation.
+
+
  Attributes are:
+
    minX = minimum X coordinate of the animation canvas
+
    minY = minimum Y coordinate of the animation canvas
+
    maxX = maximum X coordinate of the animation canvas
+
    maxY = maximum Y coordinate of the animation canvas
+
+
  Example:
+
  <topology minX = "-6.42025" minY = "-6.48444" maxX = "186.187" maxY = "188.049">
+
 
+
==== <node> element ====
+
This element describes each Node's Id and X,Y co-ordinate (position)
+
 
+
  Attributes are:
+
    lp = Logical Processor Id (Used for distributed simulations only)
+
    id = Node Id
+
    locX = X coordinate
+
    locY = Y coordinate
+
 
+
  Example:
+
  <node lp = "0" id = "8" locX = "107.599" locY = "96.9366" />
+
 
+
==== <link> element ====
+
This element describes wired links between two nodes.
+
 
+
  Attributes are:
+
    fromLp = From logical processor Id  (Used for distributed simulations only)
+
    fromId = From Node Id (first node id)
+
    toLp  = To logical processor Id
+
    toId  = To Node Id (second node id)
+
 
+
  Example:
+
  <link fromLp="0" fromId="0" toLp="0" toId="1"/>
+
 
+
====  <packet> element ====
+
This element describes a packet over wired links being transmitted at some node and received at another
+
The reception details is described in it associated rx element
+
 
+
  Attributes are:
+
    fromLp = From logical processor Id  (Used for distributed simulations only)
+
    fromId = Node Id transmitting the packet
+
    fbTx = First bit transmit time of the packet
+
    lbTx = Last bit transmit time of the packet
+
 
+
  Example:
+
  <packet fromLp="0" fromId="1" fbTx="1" lbTx="1.000067199"><rx toLp="0" toId="0" fbRx="1.002" lbRx="1.002067199"/>
+
  Packet over wired-links from Node 1 was received at Node 0. The first bit of the packet was transmitted at  the 1th second, the last bit was transmitted at the
+
  1.000067199th second of the simulation
+
  Node 0 received the first bit of the packet at the 1.002th second and the last bit of the packet at the 1.002067199th second of the simulation
+
 
+
NOTE: A packet with fromId == toId is a dummy packet used internally by the AnimationInterface.Please ignore this packet
+
 
+
===== <rx> element =====
+
This element describes the reception of a packet at a node
+
 
+
  Attributes are:
+
    toLp = To logical processor Id
+
    toId = Node Id receiving the packet
+
    fbRx = First bit Reception Time of the packet
+
    lbRx = Last bit Reception Time of the packet
+
 
+
==== <wpacket> element ====
+
This element describes a packet over wireless links being transmitted at some node and received at another
+
The reception details is described in it associated rx element
+
 
+
  Attributes are:
+
    fromLp = From logical processor Id (Used in distributed simulations only)
+
    fromId = Node Id transmitting the packet
+
    fbTx = First bit transmit time of the packet
+
    lbTx = Last bit transmit time of the packet
+
    range = Range of the transmission
+
 
+
  Example:
+
  <wpacket fromLp = "0" fromId = "20" fbTx = "0.003" lbTx = "0.003254" range = "59.68176982">
+
  <rx toLp="0" toId="32" fbRx="0.003000198" lbRx="0.003254198"/>
+
  Packet over wireless-links from Node 20 was received at Node 32. The first bit of the packet was transmitted at  the 0.003th second,
+
  the last bit was transmitted at the
+
  0.003254 second of the simulation
+
  Node 0 received the first bit of the packet at the 0.003000198 second and the last bit of the packet at the 0.003254198 second of the simulation
+
 
+
== Using the XML trace with NetAnim ==
+
 
+
* Here is a youtube video demonstrating Animation for Wireless transmission [http://www.youtube.com/watch?v=-ObcW85Go8M click here]
+
* Here is a youtube video demonstrating Animation for Wired transmission [https://www.youtube.com/watch?v=DW6upNpJQns click here]
+
 
+
 
+
=== Parts of the basic-mode Animator ===
+
The basic-mode Animator will have the following buttons shown here [[File:GeneralVCR.png]]
+
 
+
* Quit: Quits the NetAnim application
+
* Concentric circles: Shows Wireless transmission as concentric circles
+
* Reverse play button: Plays the animation in the reverse direction. Don't use this if "Track" button is enabled
+
* Forward play button: Plays the animation in the forward direction
+
* Pause button: Used to pause the animation
+
* The History slider: Used to go back in simulation time [[File:History.png]]
+
 
+
* Update rate slider: [[File:Updateperiod.png]]
+
This slider controls the interval between updating animation. If it is low, more packets will be animated, but the simulation progress will be slow
+
<font color=red>'''If it is high, some packets may get skipped, although the simulation may progress faster.
+
'''</font color>
+
 
+
 
+
[[File:miscbuttons.png]]
+
* Record button: WIll take snapshots of the animation at periodic intervals and store them as a collection of images under the "recordings" folder
+
* Zoom-in button: Zoom into the animation
+
* Zoom-out button: Zoom out
+
* Reset Zoom
+
* Pkt ON: If suppressed will display packet transmission. Disable this button, when you are only interested in seeing the location of the nodes (or mobility)
+
 
+
[[File:shownode.png]]
+
* Show Node Id: If enabled shows the Node Id of each node on the canvas
+
* Node Id Font size: Controls the font size of the Node Id mentioned above
+
 
+
=== Using the XML trace file in NetAnim 2.0 ===
+
# Open the XML file via "Options" menu --> "Load XML"
+
 
+
=== Using the non-XML trace file in NetAnim 1.0 ===
+
# use the command-line
+
./NetAnim dumbbell-tr
+
 
+
 
+
 
+
== F.A.Q ==
+
* I get
+
/usr/bin/ld: cannot find -lsqlite3
+
/usr/bin/ld: cannot find -lpng14
+
/usr/bin/ld: cannot find -lintl
+
>>> Try removing the corresponding "-l" phrases from the LIBS variable in NetAnim.pro
+
 
+
* I get GLib-GIO:ERROR:gdbusconnection.c:2279:initable_init: assertion failed: (connection->initialization_error == NULL)Aborted (core dumped)
+
>>> Don't install or run NetAnim as a root-user
+
 
+
* I get
+
QImage: XPM pixels missing on image line 9 (possibly a C++ trigraph).
+
QImage: XPM pixels missing on image line 10 (possibly a C++ trigraph).
+
QImage: XPM pixels missing on image line 11 (possibly a C++ trigraph).
+
QImage: XPM pixels missing on image line 12 (possibly a C++ trigraph).
+
QImage: XPM pixels missing on image line 13 (possibly a C++ trigraph).
+
QImage: XPM pixels missing on image line 14 (possibly a C++ trigraph)
+
 
+
>>> These can be ignored
+
 
+
* I am unable to see any packets animated
+
  
>>> If you are using Wireless links , try using the "Track" button
+
* 3.106
>>> If you are using Wired links, try disabling the "Track" button
+
[[ NetAnim 3.106 ]]
  
* The program hangs or crashes
+
* 3.105 bundled with ns-3.20
>>> Double-check if the "Special-rules" section has been followed
+
[[ NetAnim 3.105 ]]
  
* I get *.so not found. Try using -rpath
+
* 3.104 bundled with ns-3.19
>>> ensure that you have set LD_LIBRARY_PATH correctly
+
[[ NetAnim 3.104 ]]

Latest revision as of 13:17, 5 October 2017

Main Page - Current Development - Developer FAQ - Tools - Related Projects - Project Ideas - Summer Projects

Installation - Troubleshooting - User FAQ - HOWTOs - Samples - Models - Education - Contributed Code - Papers

NetAnim is an offline animator based on the Qt toolkit. It currently animates the simulation using an XML trace file collected during simulation. The first version was developed by George F Riley.

The NetAnim GUI

NetAnim Versions

  • 3.108 bundled with ns-3.27

NetAnim 3.108

  • 3.107

NetAnim 3.107

  • 3.106

NetAnim 3.106

  • 3.105 bundled with ns-3.20

NetAnim 3.105

  • 3.104 bundled with ns-3.19

NetAnim 3.104