Minor improvements in elevator example

simnation · simnation · commit 94279479dea0 · 2021-01-02T22:41:59.000+01:00
diff --git a/JSimpleSim/.gitignore b/JSimpleSim/.gitignore
diff --git a/JSimpleSim/.settings/org.eclipse.jdt.ui.prefs b/JSimpleSim/.settings/org.eclipse.jdt.ui.prefs
@@ -1,3 +1,4 @@
+cleanup.add_all=false
 cleanup.add_default_serial_version_id=true
 cleanup.add_generated_serial_version_id=false
 cleanup.add_missing_annotations=true
@@ -11,26 +12,54 @@ cleanup.always_use_blocks=true
 cleanup.always_use_parentheses_in_expressions=true
 cleanup.always_use_this_for_non_static_field_access=false
 cleanup.always_use_this_for_non_static_method_access=false
+cleanup.arrays_fill=false
+cleanup.bitwise_conditional_expression=false
+cleanup.boolean_literal=false
+cleanup.break_loop=false
+cleanup.collection_cloning=false
+cleanup.comparison_statement=false
 cleanup.convert_functional_interfaces=true
 cleanup.convert_to_enhanced_for_loop=false
+cleanup.convert_to_enhanced_for_loop_if_loop_var_used=false
+cleanup.convert_to_switch_expressions=false
 cleanup.correct_indentation=true
+cleanup.double_negation=false
+cleanup.else_if=false
+cleanup.embedded_if=false
+cleanup.evaluate_nullable=false
 cleanup.format_source_code=true
 cleanup.format_source_code_changes_only=false
+cleanup.hash=false
+cleanup.if_condition=false
 cleanup.insert_inferred_type_arguments=false
-cleanup.make_local_variable_final=true
+cleanup.instanceof=false
+cleanup.join=false
+cleanup.lazy_logical_operator=false
+cleanup.make_local_variable_final=false
 cleanup.make_parameters_final=false
 cleanup.make_private_fields_final=true
 cleanup.make_type_abstract_if_missing_method=false
 cleanup.make_variable_declarations_final=true
+cleanup.map_cloning=false
+cleanup.merge_conditional_blocks=false
 cleanup.never_use_blocks=false
 cleanup.never_use_parentheses_in_expressions=false
+cleanup.no_string_creation=false
+cleanup.no_super=true
+cleanup.number_suffix=false
+cleanup.objects_equals=false
 cleanup.organize_imports=true
+cleanup.overridden_assignment=false
+cleanup.precompile_regex=false
+cleanup.primitive_serialization=false
+cleanup.pull_up_assignment=false
 cleanup.push_down_negation=false
 cleanup.qualify_static_field_accesses_with_declaring_class=false
 cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true
 cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true
 cleanup.qualify_static_member_accesses_with_declaring_class=true
 cleanup.qualify_static_method_accesses_with_declaring_class=false
+cleanup.redundant_falling_through_block_end=false
 cleanup.remove_private_constructors=true
 cleanup.remove_redundant_modifiers=true
 cleanup.remove_redundant_semicolons=true
@@ -47,19 +76,29 @@ cleanup.remove_unused_private_fields=true
 cleanup.remove_unused_private_members=false
 cleanup.remove_unused_private_methods=true
 cleanup.remove_unused_private_types=true
+cleanup.simplify_lambda_expression_and_method_ref=false
 cleanup.sort_members=false
 cleanup.sort_members_all=false
+cleanup.strictly_equal_or_different=false
+cleanup.stringbuilder=false
+cleanup.switch=false
+cleanup.ternary_operator=false
+cleanup.try_with_resource=false
 cleanup.use_anonymous_class_creation=false
 cleanup.use_autoboxing=true
 cleanup.use_blocks=false
 cleanup.use_blocks_only_for_return_and_throw=false
+cleanup.use_directly_map_method=false
 cleanup.use_lambda=true
 cleanup.use_parentheses_in_expressions=true
 cleanup.use_this_for_non_static_field_access=true
 cleanup.use_this_for_non_static_field_access_only_if_necessary=true
 cleanup.use_this_for_non_static_method_access=false
 cleanup.use_this_for_non_static_method_access_only_if_necessary=true
 cleanup.use_unboxing=true
+cleanup.use_var=false
+cleanup.useless_continue=false
+cleanup.useless_return=false
 cleanup_profile=_DEVS
 cleanup_settings_version=2
 eclipse.preferences.version=1
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/DynamicMain.java b/JSimpleSim/src/org/simplesim/examples/elevator/DynamicMain.java
@@ -39,7 +39,7 @@
 public class DynamicMain {
 
 	/**
-	 * @param args
+	 * Example main method on how to set up a dynamic simulation model
 	 */
 	public static void main(String[] args) {
 		final DynamicModel model=new DynamicModel();
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/StaticMain.java b/JSimpleSim/src/org/simplesim/examples/elevator/StaticMain.java
@@ -16,12 +16,11 @@
 import org.simplesim.simulator.SequentialDESimulator;
 import org.simplesim.simulator.Simulator;
 
-/**
- * 
- *
- */
 public class StaticMain {
 	
+	/**
+	 * Example main method on how to set up a static simulation model
+	 */
 	public static void main(String[] args) {
 		final StaticModel model=new StaticModel();
 
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicElevator.java b/JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicElevator.java
@@ -21,7 +21,7 @@
 /**
  * Part of the dynamic elevator example
  * 
- * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain 
  * 
  */
 public final class DynamicElevator extends RoutingAgent<ElevatorState, Elevator.Event> implements Elevator {
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicModel.java b/JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicModel.java
@@ -10,7 +10,7 @@
 /**
  * Part of the dynamic elevator example
  * 
- * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain 
  * 
  */
 public class DynamicModel extends RoutingDomain {
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicVisitor.java b/JSimpleSim/src/org/simplesim/examples/elevator/dyn/DynamicVisitor.java
@@ -28,7 +28,7 @@
 /**
  * Part of the dynamic elevator example
  * 
- * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain 
  * 
  */
 public final class DynamicVisitor extends RoutingAgent<VisitorState, Visitor.Event> implements Visitor {
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/dyn/Floor.java b/JSimpleSim/src/org/simplesim/examples/elevator/dyn/Floor.java
@@ -17,7 +17,7 @@
  * 
  * The Floor class models one story of the building and contains the level of the floor
  * 
- * @see org.simplesim.elevator.DynamicMain DynamicMain 
+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain 
  * 
  */
 public final class Floor extends RoutingDomain {
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/shared/ElevatorMessage.java b/JSimpleSim/src/org/simplesim/examples/elevator/shared/ElevatorMessage.java
@@ -0,0 +1,15 @@
+/*
+ * JSimpleSim is a framework to build multi-agent systems in a quick and easy way. This software is published as open
+ * source and licensed under the terms of GNU GPLv3.
+ * 
+ * Contributors: - Rene Kuhlemann - development and initial implementation
+ */
+package org.simplesim.examples.elevator.shared;
+
+/**
+ * 
+ *
+ */
+public class ElevatorMessage {
+
+}
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/stat/StaticElevator.java b/JSimpleSim/src/org/simplesim/examples/elevator/stat/StaticElevator.java
@@ -28,7 +28,7 @@
 /**
  * Part of the static elevator example
  * 
- * @see org.simplesim.elevator.StaticMain StaticMain 
+ * @see org.simplesim.examples.elevator.StaticMain StaticMain 
  * 
  */
 public final class StaticElevator extends AbstractAgent<ElevatorState, Elevator.Event> implements Elevator {
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/stat/StaticModel.java b/JSimpleSim/src/org/simplesim/examples/elevator/stat/StaticModel.java
@@ -11,7 +11,7 @@
 /**
  * Part of the static elevator example
  * 
- * @see org.simplesim.elevator.StaticMain StaticMain 
+ * @see org.simplesim.examples.elevator.StaticMain StaticMain  
  * 
  */
 public final class StaticModel extends AbstractDomain {
diff --git a/JSimpleSim/src/org/simplesim/examples/elevator/stat/StaticVisitor.java b/JSimpleSim/src/org/simplesim/examples/elevator/stat/StaticVisitor.java
@@ -29,7 +29,7 @@
 /**
  * Part of the static elevator example
  * 
- * @see org.simplesim.elevator.StaticMain StaticMain 
+ * @see org.simplesim.examples.elevator.StaticMain StaticMain  
  * 
  */
 public final class StaticVisitor extends AbstractAgent<VisitorState, Visitor.Event> implements Visitor {
diff --git a/JSimpleSim/src/org/simplesim/model/AbstractDomain.java b/JSimpleSim/src/org/simplesim/model/AbstractDomain.java
@@ -97,19 +97,46 @@ public final Iterable<BasicModelEntity> listDomainEntities() {
 	}
 
 	/**
-	 * Checks for model.
+	 * Checks, if this domain contains a given model.
 	 *
 	 * @param model the model
-	 * @return true, if checks for model
+	 * @return true, if this domain contains the given submodel
 	 */
 	public final boolean containsEntity(BasicModelEntity model) {
 		return getEntityList().contains(model);
 	}
 
+	/**
+	 * Returns the submodel with a given index.
+	 *
+	 * @param index the index of the model within this domain's submodel list
+	 * @return the submodel
+	 * 
+	 * @throws IndexOutOfBoundsException
+	 */
 	public final BasicModelEntity getDomainEntity(int index) {
 		return getEntityList().get(index);
 	}
+	
+	/**
+	 * Checks, if this domain is the root of the model.
+	 *
+	 * @return true, if this domain it the root of the model
+	 */
+	public final boolean isRoot() {
+		return getParent()==null;
+	}
 
+	/**
+	 * Returns the root domain of the model.
+	 *
+	 * @return the root domain
+	 */
+	public final AbstractDomain getRoot() {
+		if (!isRoot()) return getParent().getRoot();
+		return this;
+	}
+	
 	List<BasicModelEntity> getEntityList() {
 		return entityList;
 	}
diff --git a/JSimpleSim/src/org/simplesim/model/RoutingDomain.java b/JSimpleSim/src/org/simplesim/model/RoutingDomain.java
@@ -98,9 +98,10 @@ public RoutingDomain() {
 	/**
 	 * Defines the domain as root domain of the model.
 	 * <p>
-	 * Should be called from the constructor of the derived class or during model building. Can only be called once.
+	 * Should be called from the constructor of the derived class or during model building. Only call once!
 	 */
 	public void setAsRootDomain() {
+		setParent(null);
 		setAddress(ROOT_ADDRESS);
 		getOutport().connectTo(getInport());
 	}

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`/**`
`22`	`22`	`* Part of the dynamic elevator example`
`23`	`23`	`*`
`24`		`- * @see org.simplesim.elevator.DynamicMain DynamicMain`
	`24`	`+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain`
`25`	`25`	`*`
`26`	`26`	`*/`
`27`	`27`	`public final class DynamicElevator extends RoutingAgent<ElevatorState, Elevator.Event> implements Elevator {`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`/**`
`11`	`11`	`* Part of the dynamic elevator example`
`12`	`12`	`*`
`13`		`- * @see org.simplesim.elevator.DynamicMain DynamicMain`
	`13`	`+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain`
`14`	`14`	`*`
`15`	`15`	`*/`
`16`	`16`	`public class DynamicModel extends RoutingDomain {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`/**`
`29`	`29`	`* Part of the dynamic elevator example`
`30`	`30`	`*`
`31`		`- * @see org.simplesim.elevator.DynamicMain DynamicMain`
	`31`	`+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain`
`32`	`32`	`*`
`33`	`33`	`*/`
`34`	`34`	`public final class DynamicVisitor extends RoutingAgent<VisitorState, Visitor.Event> implements Visitor {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`*`
`18`	`18`	`* The Floor class models one story of the building and contains the level of the floor`
`19`	`19`	`*`
`20`		`- * @see org.simplesim.elevator.DynamicMain DynamicMain`
	`20`	`+ * @see org.simplesim.examples.elevator.DynamicMain DynamicMain`
`21`	`21`	`*`
`22`	`22`	`*/`
`23`	`23`	`public final class Floor extends RoutingDomain {`