[Shox-cvs] SF.net SVN: shox:[2089] trunk/conf/examples/layer-prog-Intro.txt

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

Revision: 2089
          http://shox.svn.sourceforge.net/shox/?rev=2089&view=rev
Author:   dirk_held
Date:     2009-07-02 14:39:00 +0000 (Thu, 02 Jul 2009)

Log Message:
-----------
rewrote intro.

Modified Paths:
--------------
    trunk/conf/examples/layer-prog-Intro.txt

Modified: trunk/conf/examples/layer-prog-Intro.txt
===================================================================
--- trunk/conf/examples/layer-prog-Intro.txt	2009-07-02 14:28:06 UTC (rev 2088)
+++ trunk/conf/examples/layer-prog-Intro.txt	2009-07-02 14:39:00 UTC (rev 2089)
@@ -1,19 +1,19 @@
 0 quick overview
 
-The most basic methods a layer has to implement are the lowerSAP (service access point) and the 
-upperSAP (the application layer has no such thing). All packets go through these calls. Each layer 
-also has to listen to (own) wakeup calls. The central hub for these events is the processWakeUpCall 
+The following text will refer to the OptimalSourceRoutingLayer class (OSRL), which is located in 
+net.sf.shox.simulator.node.user is a short example, how to implement a (network) layer. The most 
+basic methods a layer has to implement are the lowerSAP (service access point) and the upperSAP
+(the application layer has no such thing). All packets go through these calls. Each layer also 
+has to listen to (own) wakeup calls. The central hub for these events is the processWakeUpCall 
 method. All timer events for example go through this call. If you need to configure your layer 
 depending on the configuration, the initConfiguration method is the place to go. The configuration 
 object contains some external values, like simulation duration or node count. All the parameters, 
-which you have created, by marking your variables with a @ShoXParameter tag, a filled now. In 
-most cases the processEvent calls with a Initialize, StartSimulation or Finalize event are used too, 
-to take action in the respective phase of the simulation run. No layer should send packets prior the 
-StartSimulation event. Any final statistics for example must be collected, when the Finalize event is 
-received. A layer may have some states, which may me exported or even may be modified by other 
-layers. To do so, the methods getState and setState are used. The OptimalSourceRoutingLayer class 
-(OSRL), which is located in net.sf.shox.simulator.node.user is a short example, how to implement a
-layer. The following text will mainly use this implementation of a network-layer as simple example.
+which you have created, by marking your variables with a @ShoXParameter tag, a filled now. In most 
+cases the processEvent calls with a Initialize, StartSimulation or Finalize event are used too, to 
+take action in the respective phase of the simulation run. No layer should send packets prior the 
+StartSimulation event. Any final statistics for example must be collected, when the Finalize event 
+is received. A layer may have some states, which may me exported or even may be modified by other 
+layers. To do so, the methods getState and setState are used.
 
 1. some predefined variables and methods, to use
 


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