[Shox-cvs] SF.net SVN: shox:[2093] trunk/conf/examples/configuration-Intro.txt

[<dir...@us...>]

Revision: 2093
          http://shox.svn.sourceforge.net/shox/?rev=2093&view=rev
Author:   dirk_held
Date:     2009-07-09 11:19:30 +0000 (Thu, 09 Jul 2009)

Log Message:
-----------
small clarifications.

Modified Paths:
--------------
    trunk/conf/examples/configuration-Intro.txt

Modified: trunk/conf/examples/configuration-Intro.txt
===================================================================
--- trunk/conf/examples/configuration-Intro.txt	2009-07-09 11:10:38 UTC (rev 2092)
+++ trunk/conf/examples/configuration-Intro.txt	2009-07-09 11:19:30 UTC (rev 2093)
@@ -3,15 +3,14 @@
 
 1 locating and using sample configurations
 
-You can find several sample configurations in the "shox/conf" directory. Have a 
-look at "shox/conf/examples/OSRdynamic.xml", which is used as example in this 
-documentation. To start a simulation, you have to add a new run-configuration to 
-Eclipse (open menu  "Run/Run Configurations..." and add a new Java Application). 
-On the main-tab, you add the project shox (depending on your choice, when creating 
-the shox project). The main class is "net.sf.shox.simulator.kernel.Simulator". In 
-the Arguments-tab, you add the configuration, you want to run. For this example, 
-use "conf/examples/OSRdynamic.xml". To start the gui, use the main-class 
-"net.sf.shox.visual.ShoX" with no arguments.
+You can find several sample configurations in the "shox/conf" directory. Please open now 
+the file "shox/conf/examples/OSRdynamic.xml". This configuration is used as main example 
+in this documentation. To start a simulation, you have to add a new run-configuration to 
+Eclipse (open menu  "Run/Run Configurations..." and add a new Java Application). On the 
+main-tab, you add the project shox (depending on your choice, when creating the shox 
+project). The main class is "net.sf.shox.simulator.kernel.Simulator". In the Arguments-tab, 
+you add the configuration, you want to run (use the configuration, you just have opened). 
+To start the gui, use the main-class "net.sf.shox.visual.ShoX" with no arguments.
 
 2 sections of a configuration file
 
@@ -38,19 +37,19 @@
 
 2.2 size of the field, node positioning and movement
  
-The field-section (l. 10-12) defines the size of the used field, where the nodes are 
-placed in. The used unit is the same as the unit used for the radio-model. The positions-
-section (l. 13-21) defines the class, which is used to generate the initial placement of 
-all nodes. Alternatives to the used RandomStartPositions class are the GridPositionGenerator 
-and the UniformStartPositions class. The first one positions the nodes on a grid and uses a 
-tunable minimal distance, to set all nodes apart. Each line is filled before the next line 
-is started. The second tries to position the nodes uniformly positioned in both directions, 
-where the grid dimensions are as close as possible to sqrt(#Nodes) (for ex. are 100 nodes 
-placed in a 10 times 10 grid). If this does not suit your needs, you can implement your own 
-position generator by implementing a subclass of  the StartPositionGenerator class. You can 
-do this of course for all referenced classes too. Open the an example implementation and
-find its super-class and which methods to implement. Most aspects of the ShoX framework can
-be replaced this way. 
+The field-section (l. 10-12) defines the size of the rectangular network area, where the 
+nodes are placed in. The used unit is the same as the unit used for the radio-model. The 
+positions-section (l. 13-21) defines the class, which is used to generate the initial 
+placement of all nodes. Alternatives to the used RandomStartPositions class are the 
+GridPositionGenerator and the UniformStartPositions class. The first one positions the 
+nodes on a grid and uses a tunable minimal distance, to set all nodes apart. Each line is 
+filled before the next line is started. The second tries to position the nodes uniformly 
+positioned in both directions, where the grid dimensions are as close as possible to 
+sqrt(#Nodes) (for example are 100 nodes placed in a 10 times 10 grid). If this does not suit 
+your needs, you can implement your own position generator by implementing a subclass of  
+the StartPositionGenerator class. You can do this of course for all referenced classes too. 
+Open the example implementation for the task and find its super-class and which methods to 
+implement. Most aspects of the ShoX framework can be replaced this way. 
 
 If you activate the nodefile section, you can specify a file, where the generated positions 
 will be written to. If you omit the generated-section but supply the nodefile section, the 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.