Improved elevator example and comments

Author: simnation

JSimpleSim/src/org/simplesim/examples/SimpleAgent.java

@@ -11,12 +11,12 @@
 import org.simplesim.model.State;
 
 /**
- * Example of a simple implementation of an {@code RoutingAgent}
+ * Simple implementation of a {@code RoutingAgent} as template for own implementations
  */
-public class SimpleAgent extends RoutingAgent<SimpleAgent.SimpleAgentState, SimpleAgent.EVENT> {
+public class SimpleAgent extends RoutingAgent<SimpleAgent.SimpleAgentState, SimpleAgent.Event> {
 
-	enum EVENT {
-		event1, event2, event3
+	enum Event {
+		EVENT1, EVENT2, EVENT3
 	}
 
 	static class SimpleAgentState implements State {
@@ -42,21 +42,27 @@ protected Time doEvent(Time time) {
 		return getTimeOfNextEvent();
 	}
 
-	private void sendMessage(RoutingAgent<?,?> destination, Object content) {
+	protected void sendMessage(RoutingAgent<?,?> destination, Object content) {
 		RoutedMessage message=new RoutedMessage(this.getAddress(),destination.getAddress(),content);
 		getOutport().write(message);
 	}
 
+	/*
+	 * Do the message handling here.
+	 */
 	private void handleMessage(RoutedMessage message) {
-		/*
-		 * Do the message handling here.
-		 */
+
 	}
 
-	private void handleEvent(EVENT event, Time time) {
-		/*
-		 * Do the event handling here.
-		 */
+	/*
+	 * Do the event handling here.
+	 */
+	private void handleEvent(Event event, Time time) {
+		switch(event) {
+		case EVENT1: ;
+		case EVENT2: ;
+		case EVENT3: ;
+		};
 	}
 
 }

JSimpleSim/src/org/simplesim/examples/SimpleDomain.java

@@ -10,9 +10,14 @@
 import org.simplesim.core.messaging.RoutedMessageForwarding;
 import org.simplesim.core.scheduling.Time;
 import org.simplesim.model.RoutingDomain;
+import org.simplesim.simulator.DynamicDecorator;
 import org.simplesim.simulator.SequentialDESimulator;
 import org.simplesim.simulator.Simulator;
 
+
+/**
+ * Simple implementation of a {@code RoutingDomain} 
+ */
 public class SimpleDomain extends RoutingDomain {
 
 	public SimpleDomain() {
@@ -28,9 +33,8 @@ public static void main(String[] args) {
 		subdomain.addEntity(new SimpleAgent());
 		root.addEntity(subdomain);
 		ForwardingStrategy fs=new RoutedMessageForwarding(root);
-		//final Simulator simulator=new DynamicDecorator(new ConcurrentDESimulator(model,fs));
-		Simulator simulator=new SequentialDESimulator(root,fs);
-		simulator.runSimulation(new Time(Time.TICKS_PER_HOUR));
+		Simulator simulator=new DynamicDecorator(new SequentialDESimulator(root,fs));
+		simulator.runSimulation(new Time(Time.INFINITY));
 	}
 
 }

JSimpleSim/src/org/simplesim/examples/elevator/DynamicMain.java

@@ -8,20 +8,33 @@
 import org.simplesim.core.messaging.ForwardingStrategy;
 import org.simplesim.core.messaging.RoutedMessageForwarding;
 import org.simplesim.core.scheduling.Time;
-import org.simplesim.examples.elevator.core.Limits;
-import org.simplesim.examples.elevator.core.View;
 import org.simplesim.examples.elevator.dyn.DynamicElevator;
 import org.simplesim.examples.elevator.dyn.DynamicModel;
 import org.simplesim.examples.elevator.dyn.DynamicVisitor;
 import org.simplesim.examples.elevator.dyn.Floor;
+import org.simplesim.examples.elevator.shared.Limits;
+import org.simplesim.examples.elevator.shared.View;
 import org.simplesim.simulator.DynamicDecorator;
 import org.simplesim.simulator.SequentialDESimulator;
 import org.simplesim.simulator.Simulator;
 
 /**
- * Example of a multi-domain agent system with direct messaging
+ * Example of a multi-domain agent system with routed messaging and dynamic model changes
  * <p>
- * This
+ * To illustrate differences of a static and a dynamic modeling approach, both are used with the same simulation problem: the steering strategy of an elevator.
+ * Common data structure, the steering algorithm and the graphical representation are shared, so the focus lies on
+ * the differences of both approaches:
+ * <p>
+ * <u>Static model:</u><ul>
+ * <li> Visitors store their current floor in their state.
+ * <li> Ports of elevator and visitor are connected directly.
+ * <li>  
+ *  </ul>
+ * 
+ *  
+ * (no model changes) (model is changed during the 
+ * simulation run)
+ *  nThis is the dynamic variant of the elevator simulation example to illustrate differences from the static apporach. 
  */
 public class DynamicMain {
 

JSimpleSim/src/org/simplesim/examples/elevator/StaticMain.java

@@ -8,8 +8,8 @@
 
 import org.simplesim.core.messaging.DirectMessageForwarding;
 import org.simplesim.core.scheduling.Time;
-import org.simplesim.examples.elevator.core.Limits;
-import org.simplesim.examples.elevator.core.View;
+import org.simplesim.examples.elevator.shared.Limits;
+import org.simplesim.examples.elevator.shared.View;
 import org.simplesim.examples.elevator.stat.StaticElevator;
 import org.simplesim.examples.elevator.stat.StaticModel;
 import org.simplesim.examples.elevator.stat.StaticVisitor;

JSimpleSim/src/org/simplesim/examples/elevator/core/Visitor.java

@@ -5,50 +5,48 @@
  */
 package org.simplesim.examples.elevator.dyn;
 
-import static org.simplesim.examples.elevator.core.Limits.LOBBY;
-import static org.simplesim.examples.elevator.core.Limits.START_DAY;
+import static org.simplesim.examples.elevator.shared.Limits.LOBBY;
+import static org.simplesim.examples.elevator.shared.Limits.START_DAY;
 
 import org.simplesim.core.messaging.RoutedMessage;
 import org.simplesim.core.scheduling.Time;
-import org.simplesim.examples.elevator.core.Elevator;
-import org.simplesim.examples.elevator.core.ElevatorState;
-import org.simplesim.examples.elevator.core.ElevatorStrategy;
-import org.simplesim.examples.elevator.core.Limits;
-import org.simplesim.examples.elevator.core.Request;
+import org.simplesim.examples.elevator.shared.Elevator;
+import org.simplesim.examples.elevator.shared.ElevatorState;
+import org.simplesim.examples.elevator.shared.ElevatorStrategy;
+import org.simplesim.examples.elevator.shared.Limits;
+import org.simplesim.examples.elevator.shared.Request;
 import org.simplesim.model.AbstractAgent;
 import org.simplesim.model.RoutingAgent;
 
 /**
- * Elevator agent implementing a simple planning strategy
- * <ul>
- * <li>If there is any request in direction of movement with the same direction, go to the nearest one.
- * <li>If there is any other request in direction of movement, go to the farthest one.
- * <li>If there is no other request in direction of movement, change direction.
- * </ul>
+ * Part of the dynamic elevator example
+ * 
+ * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * 
  */
-public final class DynamicElevator extends RoutingAgent<ElevatorState, Elevator.EVENT> implements Elevator {
+public final class DynamicElevator extends RoutingAgent<ElevatorState, Elevator.Event> implements Elevator {
 
 	private final ElevatorStrategy strategy;
 
 	public DynamicElevator() {
 		super(new ElevatorState());
+		strategy=new ElevatorStrategy(this);
 		getState().setCurrentFloor(LOBBY);
 		getState().setDestinationFloor(LOBBY);
 		getState().setDirection(Limits.IDLE);
-		strategy=new ElevatorStrategy(this);
-		enqueueEvent(EVENT.idle,START_DAY);
+		enqueueEvent(Event.IDLE,START_DAY);
 	}
 
 	@Override
 	protected Time doEvent(Time time) {
 		switch (getEventQueue().dequeue()) {
-		case moved: // just arrived on new floor
+		case MOVED: // just arrived on new floor
 			getState().setCurrentFloor(getState().getDestinationFloor());
 			strategy.processMoveEvent(time);
 			break;
-		case idle: // nothing to do, wait for passengers
+		case IDLE: // nothing to do, wait for passengers
 			if (getInport().hasMessages()) strategy.processMoveEvent(time);
-			else enqueueEvent(EVENT.idle,time.add(Limits.IDLE_TIME));
+			else enqueueEvent(Event.IDLE,time.add(Limits.IDLE_TIME));
 			break;
 		default:
 			throw new UnknownEventType("Unknown event type occured in ElevatorStrategy");
@@ -85,7 +83,7 @@ public void sendMessage(AbstractAgent<?, ?> recipient, Request content) {
 	 * org.simplesim.core.scheduling.Time)
 	 */
 	@Override
-	public void enqueueEvent(EVENT event, Time time) {
+	public void enqueueEvent(Event event, Time time) {
 		getEventQueue().enqueue(event,time);
 	}
 

JSimpleSim/src/org/simplesim/examples/elevator/core/package-info.java

@@ -8,8 +8,10 @@
 import org.simplesim.model.RoutingDomain;
 
 /**
- *
- *
+ * Part of the dynamic elevator example
+ * 
+ * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * 
  */
 public class DynamicModel extends RoutingDomain {
 

JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicElevator.java

@@ -5,31 +5,33 @@
  */
 package org.simplesim.examples.elevator.dyn;
 
-import static org.simplesim.examples.elevator.core.Limits.END_WORK;
-import static org.simplesim.examples.elevator.core.Limits.IDLE_TIME;
-import static org.simplesim.examples.elevator.core.Limits.LOBBY;
-import static org.simplesim.examples.elevator.core.Limits.MAX_FLOOR;
-import static org.simplesim.examples.elevator.core.Limits.START_DAY;
-import static org.simplesim.examples.elevator.core.Limits.START_WORK;
+import static org.simplesim.examples.elevator.shared.Limits.END_WORK;
+import static org.simplesim.examples.elevator.shared.Limits.IDLE_TIME;
+import static org.simplesim.examples.elevator.shared.Limits.LOBBY;
+import static org.simplesim.examples.elevator.shared.Limits.MAX_FLOOR;
+import static org.simplesim.examples.elevator.shared.Limits.START_DAY;
+import static org.simplesim.examples.elevator.shared.Limits.START_WORK;
 
 import java.util.Random;
 
 import org.simplesim.core.dynamic.DomainChangeRequest;
 import org.simplesim.core.messaging.RoutedMessage;
 import org.simplesim.core.scheduling.Time;
-import org.simplesim.examples.elevator.core.Limits;
-import org.simplesim.examples.elevator.core.Request;
-import org.simplesim.examples.elevator.core.Visitor;
-import org.simplesim.examples.elevator.core.VisitorState;
-import org.simplesim.examples.elevator.core.VisitorState.ACTIVITY;
+import org.simplesim.examples.elevator.shared.Limits;
+import org.simplesim.examples.elevator.shared.Request;
+import org.simplesim.examples.elevator.shared.Visitor;
+import org.simplesim.examples.elevator.shared.VisitorState;
+import org.simplesim.examples.elevator.shared.VisitorState.ACTIVITY;
 import org.simplesim.model.AbstractAgent;
 import org.simplesim.model.RoutingAgent;
 
 /**
- *
- *
+ * Part of the dynamic elevator example
+ * 
+ * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * 
  */
-public final class DynamicVisitor extends RoutingAgent<VisitorState, Visitor.EVENT> implements Visitor {
+public final class DynamicVisitor extends RoutingAgent<VisitorState, Visitor.Event> implements Visitor {
 
 	private static final Random random=new Random();
 	private final DynamicModel building;
@@ -40,19 +42,19 @@ public DynamicVisitor(DynamicModel model) {
 		getState().setActivity(ACTIVITY.waiting);
 		// init arrival time at lobby with a random value before start of work
 		final Time time=START_DAY.add(random.nextInt((int) (START_WORK.getTicks()-START_DAY.getTicks())));
-		getEventQueue().enqueue(EVENT.changeFloor,time);
+		getEventQueue().enqueue(Event.CHANGE_FLOOR,time);
 	}
 
 	@Override
 	protected Time doEvent(Time time) {
 		switch (getEventQueue().dequeue()) {
-		case waiting:
+		case WAITING:
 			waitForElevator(time);
 			break;
-		case changeFloor:
+		case CHANGE_FLOOR:
 			changeFloor(time);
 			break;
-		case goHome:
+		case GO_HOME:
 			throw new RuntimeException("Never should get here!");
 		default:
 			throw new UnknownEventType("Unknown event type occured in "+toString());
@@ -73,14 +75,14 @@ private void waitForElevator(Time time) {
 			addModelChangeRequest(new DomainChangeRequest(this,dest));
 
 			if ((time.compareTo(END_WORK)>=1)&&(request.getDestinationFloor()==LOBBY))
-				getEventQueue().enqueue(EVENT.goHome,Time.INFINITY); // work is over, going home
+				getEventQueue().enqueue(Event.GO_HOME,Time.INFINITY); // work is over, going home
 			// go to another floor after staying here for a random time period
 			else {
 				getState().setActivity(ACTIVITY.working);
-				getEventQueue().enqueue(EVENT.changeFloor,time.add(random.nextInt(Limits.MAX_STAY_TIME)));
+				getEventQueue().enqueue(Event.CHANGE_FLOOR,time.add(random.nextInt(Limits.MAX_STAY_TIME)));
 			}
 		} // else just wait a little longer
-		else getEventQueue().enqueue(EVENT.waiting,time.add(IDLE_TIME));
+		else getEventQueue().enqueue(Event.WAITING,time.add(IDLE_TIME));
 	}
 
 	@Override
@@ -99,10 +101,11 @@ private void changeFloor(Time time) {
 		else while (destination==getCurrentFloor()) destination=1+random.nextInt(MAX_FLOOR);
 		sendRequest(building.getElevator(),destination,time);
 		getState().setActivity(ACTIVITY.waiting);
-		getEventQueue().enqueue(EVENT.waiting,time.add(IDLE_TIME));
+		getEventQueue().enqueue(Event.WAITING,time.add(IDLE_TIME));
 	}
 
-	private void sendRequest(AbstractAgent<?, ?> dest, int destination, Time time) {
+	@Override
+	public void sendRequest(AbstractAgent<?, ?> dest, int destination, Time time) {
 		final Request request=new Request(this,getCurrentFloor(),destination,time);
 		final RoutedMessage msg=new RoutedMessage(this.getAddress(),dest.getAddress(),request);
 		getOutport().write(msg); // send request to elevator

JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicModel.java

@@ -12,9 +12,13 @@
 
 import org.simplesim.model.RoutingDomain;
 
-/**
+ /**
+ * Part of the dynamic elevator example
+ * 
  * The Floor class models one story of the building and contains the level of the floor
- *
+ * 
+ * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * 
  */
 public final class Floor extends RoutingDomain {
 
@@ -31,7 +35,7 @@ public int getFloor() {
 
 	@Override
 	public String getName() {
-		return "Floor"+getFloor();
+		return "floor_"+getFloor();
 	}
 
 }