Merge branch 'master' of https://github.com/nmcl/JavaSim

Author: nmcl

LICENCE LICENCE.txtLICENCE renamed to LICENCE.txt

@@ -4,13 +4,12 @@ JavaSIM has been available since 1997 and is an object-oriented simulation packa
 - entity and set manipulation facilities similar to SIMSET.
 - classes allow "non-causal" events, such as interrupts, to be handled.
 - various statistical gathering routines, such as histogram and variance classes.
-- debugging classes.
 
 The system also comes with complete examples and test routines which illustrate many of the issues raised in using the simulation package. It is used by many commercial and academic organisations.
 
 Prior to 2007 both C++SIM and JavaSim were freely available in source and binary from Newcastle University, under their own licence. However, in late 2007 the University decided that the code can be released into open source under LGPL.
 
-We are in the process of providing new releases of JavaSim and C++SIM. In the meantime, if you want the old versions then you can find C++SIM 1.7.4 GA and JavaSim 0.3 GA available from the relevant distributions directory.
+You can find details of the releases in the https://github.com/nmcl/JavaSim/releases section as well as binary downloads.
 
 In 2015 we moved from Codehaus due to that being closed down. All JIRAs from there were also migrated to github issues.
 

README.md

@@ -111,7 +111,7 @@ public class Simulation
 }
 ----
 
-To enable multiple simulation runs to occur within a single application, it is possible to reset it and the simulation clock by calling the reset() method of the Simulation class. This causes the simulation to remove all processes (simulation objects) currently registered on the scheduler queue and to invoke a class specific method on each of them which resets their states (detailed in the next section). Once this is finished the simulation is ready for an additional run. A suspended process is informed that it has been “reset” by having the method it called to originally suspend itself (i.e., place itself on the scheduler queue) raise the RestartSimulation exception, which the object should catch. It must then perform any work necessary to put itself back in a state ready for restarting the simulation, and should then suspend itself again before the simulation can be restarted (typically by calling cancel.)
+To enable multiple simulation runs to occur within a single application, it is possible to reset it and the simulation clock by calling the reset() method of the Simulation class. This causes the simulation to remove all processes (simulation objects) currently registered on the scheduler queue and to invoke a class specific method on each of them which resets their states (detailed in the next section). Once this is finished the simulation is ready for an additional run. A suspended process is informed that it has been “reset” by having the method it called to originally suspend itself (i.e., place itself on the scheduler queue) raise the RestartSimulation exception, which the object should catch. It must then perform any work necessary to put itself back in a state ready for restarting the simulation, and should then suspend itself again before the simulation can be restarted (typically by calling cancel, which is available on the SimulationProcess class.)
 
 A process can use isReset() to determine whether or not the simulation has been reset. The start() and stop() operations allow the simulation to be halted or resumed respectively.
 
@@ -370,7 +370,7 @@ public  class  Arrivals  extends  SimulationProcess
             {
             }
         }
-        }
+    }
 }
 ----
 
@@ -749,7 +749,7 @@ Semaphores are used within the simulation system. However, they can also be used
 
 ----
 public void test () throws Exception
-    {
+{
 	Semaphore sem = new Semaphore(2);
 	DummyEntity e1 = new DummyEntity(10);
 	DummyEntity e2 = new DummyEntity(20);
@@ -773,7 +773,7 @@ public void test () throws Exception
 
 	assertTrue(result == Semaphore.Outcome.DONE);
 	assertTrue(sem.numberWaiting() == 1);
-    }
+}
 ----
 
 As can be seen, the number of resources is passed to the Semaphore when it is created. We then create 3 SimulationEntities. At this stage there are no entities waiting (blocked waiting) on the Semaphore (numberWaiting returns 0). The first two entities gain access to the resources by calling Semaphore.get() before they would access or manipulate the resource(s). In this example we know that because no entity has yet released its access to the resource (e.g., lock on the resource), the next entity to try to acquire access via Semaphore.get() will block. To verify this we can use Semaphore.tryGet(), which in this case returns Outcome.WOULD_BLOCK to indicate this fact. Regardless, we then try to acquire access to the resource(s) and that entity is then blocked. This is verified by checking the number of entities waiting on the semaphore being released, i.e., numberWaiting() returns 1 in this case.

docs/manual.adoc

@@ -110,7 +110,7 @@ public Outcome get (SimulationEntity toWait)
             catch (SimulationException e)
             {
             }
-
+	    
             toWait.cancel();
         }
 

src/main/java/org/javasim/Semaphore.java

@@ -44,7 +44,7 @@ public void testNoBreaks ()
         {
         }
     }
-    
+
     @Test
     public void testBreaks ()
     {