----------------------
README for Installation and Usage Procedure for the Obstacle Mobility Model Plugin for GlomoSim
----------------------

----------------------
Introduction
----------------------

The Obstacle Model is a mobility model developed at the Mobility Management and Networking (MOMENT) Lab, Department of Computer Science, University of California at Santa Barbara, CA - 93106.

Visit : http://moment.cs.ucsb.edu/mobility for more information


----------------------
Installation
----------------------

Modules required for the Obstacle Model Plugin are :

1. TerGen Tool (provided with the tarball)
2. The CGAL-2.4 libraries 
	(provided at http://moment.cs.ucsb.edu/mobility 
	or
	http://www.cgal.org)
3. CGAL voronoi graph code (provided with the tarball)
4. NS-2 Plugin files
5. GlomoSim Plugin files

For installation purposes, 

1. Download and install the CGAL libraries.

2. Replace the file 'voronoi.C' at ~/CGAL-2.4/examples/Triangulation_2/ with the one provided with the tarball. Provide an absolute path to the data file in the voronoi.C code. Compile the code.

3. Extract the GlomoSim code.

4. Compile the simulator code.

5. Compile the TerGen code

----------------------
Version for the TerGen Tool
----------------------

This is a GUI based tool that shall aid the user in graphically placing objects on a terrain and generating the voronoi graph by using the CGAL libraries.

1. Compiling 
	javac tergen.java

2. Usage
	- Enter the terrain size and visualization scale in the text boxes
	  e.g. if the user wants a terrain of size 1000x1000
	     enter x -> 500 y -> 500 scale -> 2

	- Draw rectangular objects on the canvas
	- For accepting an object, click on "Take Point"
	- For deleting an object, select it from the List and click "Delete"
	- Select NS-2 or GlomoSim
	- Click "Make Voronoi" to generate the input files
	  and to display the voronoi graph on the canvas.
	
3. Path Change

	- The paths for the CGAL libraries have been hard-coded.
	  Change them in tergen.java before using TerGen.
	
4. Files Generated
	a. Obstacles.txt
	   This contains the co-ordinate positions of the obstacles specified. In case the user would like to place a different kind of a quadrilateral shape on the canvas, the user can manually type out the co-ordinate positions in this file.

	b. edges.in
	   This file contains the voronoi edges that are generated by TerGen. The format of this file shall depend on the tool (NS-2 or GloMoSim) chosen.

----------------------
Version for TerGen
----------------------

Release 1.0 for TerGen - The Terrain Generator!

----------------------
Version for GloMoSim Plugin
----------------------

This release is version 1.0 (first public release) of the Obstacle Model Plugin for GloMoSim.

----------------------
GlomoSim Plugin Included
----------------------

- Included in the tarball is a copy of GlomoSim along with the files that shall simulate the Obstacle Mobility model.  This copy includes changes to the original GlomoSim code as mentioned in the next section.

- The user is requested to make the following changes according to his/her requirements. Future versions of this plugin would have these parameters dynamically setup.

- In the file "mobility_obstacle.h" :

	a. MAX_NODES is the maximum number of nodes you would want in your simulation runs
	b. MAX_POSITIONS is the number of voronoi graph nodes generated.
	c. TERRAIN_X and TERRAIN_Y are the x- and y-dimensions of the terrain.


----------------------
Changes to GloMoSim
----------------------

1. config.in options
   There is an option to provide a MIN-PAUSE and a MAX-PAUSE time to the GlomoSim config.in file. The pause time for any node shall be randomly selected within that range.

2. Random Voronoi Placement
   The user is allowed to place the nodes randomly on any of the voronoi graph nodes.

3. Random Mobility Model
   This selects the usage of the Obstacle Mobility Model.

4. MAC layer propagation model
   The propagation model has been implemented in the 'mac' directory.  Packets are checked for T-R propagation path, in order to make a 'reachability decision'. Packets are dropped before they are received by the MAC layer for processing.

5. CTS Frame
   The CTS frame has been modified to be a 'short' frame. This change was involved in order to access the sender's node ID.

----------------------
Input files required from TerGen
----------------------

The following files shall be generated by TerGen.

Obstacles.txt	: This file needs to be placed in the ~/glomosim-main/glomosim/bin/ directory.
edges.in	: This file needs to be placed in the ~/glomosim-main/glomosim/bin/ directory.

----------------------
Note
----------------------

- The code is under constant improvement by the developer, in order to include more features.  In the process, the user may observe variations in the results obtained. Please do inform the developer in case of widely varying results.

-----------------------
Comments and Bug reports
----------------------
Please send all comments, suggestions and bug reports to amitj[at]cs.ucsb.edu