adjusted license header, minor internal adjustments

Admin · Admin · commit 9df4baf9f652 · 2021-04-21T01:14:20.000+02:00
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/AbstractMessage.java b/JSimpleSim/src/org/simplesim/core/messaging/AbstractMessage.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/AbstractPort.java b/JSimpleSim/src/org/simplesim/core/messaging/AbstractPort.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
@@ -69,7 +69,7 @@ public AbstractPort(BasicModelEntity model) {
 	public abstract void connectTo(AbstractPort target);
 
 	/**
-	 * Disconnects this port from another on.
+	 * Disconnects this port from another one.
 	 *
 	 * @param target the port to be removed
 	 * @exception PortConnectionException if the port is not connected with the
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/DirectMessageForwarding.java b/JSimpleSim/src/org/simplesim/core/messaging/DirectMessageForwarding.java
@@ -4,6 +4,10 @@
  *
  * 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.core.messaging;
 
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/ForwardingStrategy.java b/JSimpleSim/src/org/simplesim/core/messaging/ForwardingStrategy.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/Message.java b/JSimpleSim/src/org/simplesim/core/messaging/Message.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/MultiPort.java b/JSimpleSim/src/org/simplesim/core/messaging/MultiPort.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/RecursiveMessageForwarding.java b/JSimpleSim/src/org/simplesim/core/messaging/RecursiveMessageForwarding.java
@@ -4,6 +4,10 @@
  *
  * 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.core.messaging;
 
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/RoutedMessage.java b/JSimpleSim/src/org/simplesim/core/messaging/RoutedMessage.java
@@ -1,7 +1,13 @@
 /*
- * 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
+ * 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.core.messaging;
 
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/RoutedMessageForwarding.java b/JSimpleSim/src/org/simplesim/core/messaging/RoutedMessageForwarding.java
@@ -1,7 +1,13 @@
-/**
- * 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
+/*
+ * 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.core.messaging;
 
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/SinglePort.java b/JSimpleSim/src/org/simplesim/core/messaging/SinglePort.java
@@ -1,7 +1,13 @@
-/**
- * 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
+/*
+ * 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.core.messaging;
 
diff --git a/JSimpleSim/src/org/simplesim/core/messaging/SwitchPort.java b/JSimpleSim/src/org/simplesim/core/messaging/SwitchPort.java
@@ -1,7 +1,13 @@
-/**
- * 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
+/*
+ * 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.core.messaging;
 
diff --git a/JSimpleSim/src/org/simplesim/core/scheduling/AbstractEventQueue.java b/JSimpleSim/src/org/simplesim/core/scheduling/AbstractEventQueue.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/scheduling/EventQueueEntry.java b/JSimpleSim/src/org/simplesim/core/scheduling/EventQueueEntry.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/scheduling/HeapEventQueue.java b/JSimpleSim/src/org/simplesim/core/scheduling/HeapEventQueue.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/scheduling/MultiLevelQueue.java b/JSimpleSim/src/org/simplesim/core/scheduling/MultiLevelQueue.java
@@ -1,8 +1,12 @@
 /*
- * https://store.steampowered.com/app/1285080/Gordian_Rooms_A_curious_heritage/?snr=1_4_4__135_10&curator_clanid=
- * 34454724 * 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
+ * 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.core.scheduling;
 
@@ -23,8 +27,8 @@
  * <li>far future tier for events from {@code minTimeTier3} to {@code maxTimeTier3}
  * </ol>
  * The near future tier is sliced into equidistant time intervals. The far future tier consists of an unsorted list.
- * When shifting events form tier 3 to tier 2, partial sorting is done by index calculation. A second sorting step is
- * done by the heap functionality of tier 1.
+ * When shifting events form tier 3 to tier 2, partial sorting is done by index calculation. The final sorting step is
+ * done by sorting the list of tier 1.
  *
  * @param <E> Event type
  * @see <a href= "http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.95.4263&rep=rep1&type=pdf">Referring
@@ -199,7 +203,7 @@ private void refillTier2() {
 		// 3.) in all other case use tier3.size/TIER2_DEFAULT_BUCKET_SIZE buckets
 		int approxBucketCount=tier3.size()/TIER2_DEFAULT_BUCKET_SIZE; 
 		if (tier3.size()<=TIER2_DEFAULT_BUCKET_SIZE) approxBucketCount=1;
-		else if (approxBucketCount>TIER2_DEFAULT_BUCKET_SIZE) approxBucketCount=(int) Math.floor(Math.sqrt(tier3.size()));
+		else if (approxBucketCount>TIER2_DEFAULT_BUCKET_SIZE) approxBucketCount=(int) Math.sqrt(tier3.size());
 		// calc bucketWidth as time slice per bucket, rounded up to the next int
 		bucketWidth=(int) ((maxTimeTier3.getTicks()-minTimeTier3.getTicks())/approxBucketCount)+1;
 		// recalculate number of buckets, so that maxIndexTier2 * bucketWidth covers
diff --git a/JSimpleSim/src/org/simplesim/core/scheduling/SortedEventQueue.java b/JSimpleSim/src/org/simplesim/core/scheduling/SortedEventQueue.java
@@ -1,4 +1,4 @@
-/**
+/*
  * JSimpleSim is a framework to build multi-agent systems in a quick and easy
  * way.
  *
diff --git a/JSimpleSim/src/org/simplesim/core/scheduling/Time.java b/JSimpleSim/src/org/simplesim/core/scheduling/Time.java
@@ -6,10 +6,12 @@
 package org.simplesim.core.scheduling;
 
 /**
- * Provides time and calendar functionality to scale and navigate the simulation's time axis.
+ * Provides time and calendar functionality to scale and navigate the
+ * simulation's time axis.
  * <p>
- * Ticks are stored as {@code long} primitive. A time scale is provided, standardized with one second set to one. The
- * scale may be changed because within the simulator, only the {@code Time} wrapper is used.
+ * Ticks are stored as {@code long} primitive. A time scale is provided,
+ * standardized with one second set to one. The scale may be changed because
+ * within the simulator, only the {@code Time} wrapper is used.
  * <p>
  * This class is immutable and thus tread safe.
  */
@@ -43,29 +45,58 @@ public final class Time implements Comparable<Time> {
 	public static final Time INFINITY=new Time(Long.MAX_VALUE);
 
 	/**
-	 * This is an immutable class, so ticks are final (multiple references to a changing time instance are prone to hard
-	 * to find bugs)
+	 * This is an immutable class, so ticks are final (multiple references to a
+	 * changing time instance are prone to hard to find bugs)
 	 */
 	private final long ticks;
 
+	/**
+	 * Basic constructor
+	 *
+	 * @param value number of ticks
+	 */
 	public Time(long value) {
 		ticks=value;
 	}
 
-	// copy constructor
+	/**
+	 * Copy constructor
+	 *
+	 * @param time time to duplicate
+	 */
 	public Time(Time time) {
 		this(time.ticks);
 	}
 
+	/**
+	 * Constructor converting a given date into ticks
+	 *
+	 * @param year  the year (counting starts at zero)
+	 * @param month the month (0<x<12, counting starts at zero)
+	 * @param day   the day (0<x<30, counting starts at zero)
+	 * @param hour  the hour (0<x<24)
+	 * @param min   the minute (0<x<60)
+	 * @param sec   the second (0<x<60)
+	 */
 	public Time(int year, int month, int day, int hour, int min, int sec) {
 		this((year*TICKS_PER_YEAR)+(month*TICKS_PER_MONTH)+(day*TICKS_PER_DAY)+(hour*TICKS_PER_HOUR)
 				+(min*TICKS_PER_MINUTE)+(sec*TICKS_PER_SECOND));
 	}
 
-	public long getTicks() {
-		return ticks;
+	/**
+	 * Constructor converting a given date into ticks, facilitating shorter time
+	 * spans.
+	 *
+	 * @param day  the day (counting starts at zero)
+	 * @param hour the hour (0<x<24)
+	 * @param min  the minute (0<x<60)
+	 */
+	public Time(int day, int hour, int min) {
+		this((day*TICKS_PER_DAY)+(hour*TICKS_PER_HOUR)+(min*TICKS_PER_MINUTE));
 	}
 
+	public long getTicks() { return ticks; }
+
 	public Time add(long value) {
 		return new Time(getTicks()+value);
 	}
@@ -119,7 +150,7 @@ public boolean equals(Object obj) {
 
 	@Override
 	public int hashCode() {
-		return (int) getTicks();
+		return Long.hashCode(getTicks());
 	}
 
 	@Override
diff --git a/JSimpleSim/src/org/simplesim/model/AbstractAgent.java b/JSimpleSim/src/org/simplesim/model/AbstractAgent.java
@@ -164,19 +164,15 @@ public final Time doEventSim(Time time) {
 	}
 	
 	/**
-	 * Provide logging functionality
+	 * Provides simple logging functionality with time stamp, entity name and message output.
+	 * <p>
+	 * May be overloaded by a more sophisticated implementation.
 	 * 
 	 * @param time current time stamp
-	 * @param msg additional message to output
+	 * @param msg message to print 
 	 */
 	public void log(Time time, String msg) {
-		StringBuffer sb=new StringBuffer();
-		sb.append('[');
-		sb.append(this.getFullName());
-		sb.append(']');
-		sb.append(time.toString());
-		sb.append(msg);
-		System.out.println(sb.toString());
+		System.out.println(time.toString()+this.toString()+": "+msg);
 	}
 
 	/**
diff --git a/JSimpleSim/src/org/simplesim/model/AbstractDomain.java b/JSimpleSim/src/org/simplesim/model/AbstractDomain.java
@@ -43,13 +43,15 @@ public abstract class AbstractDomain extends BasicModelEntity {
 	 * @param entity the model to be added
 	 * @throws UniqueConstraintViolationException   if the entity is already part of this domain
 	 * @throws NullPointerException if entity is null
+	 * @return the given entity for further usage
 	 */
-	public void addEntity(BasicModelEntity entity) {
+	public <T extends BasicModelEntity> T addEntity(T entity) {
 		if (entity==null) throw new NullPointerException("Cannot add null pointer to domain "+getFullName());
 		if (containsEntity(entity)) throw new UniqueConstraintViolationException(
 				"Model "+entity.toString()+" added twice to domain "+this.getFullName());
 		entity.setParent(this);
 		getEntityList().add(entity);
+		return entity;
 	}
 
 	/**
@@ -61,7 +63,7 @@ public void addEntity(BasicModelEntity entity) {
 	 * @param entity the model to be removed
 	 * @return the removed entity if the domain contained it, null otherwise
 	 */
-	public BasicModelEntity removeEntity(BasicModelEntity entity) {
+	public <T extends BasicModelEntity> T removeEntity(T entity) {
 		if (!getEntityList().remove(entity)) return null;
 		entity.setParent(null);
 		return entity;
diff --git a/JSimpleSim/src/org/simplesim/model/BasicModelEntity.java b/JSimpleSim/src/org/simplesim/model/BasicModelEntity.java
@@ -146,12 +146,7 @@ public String getName() {
 	 */
 	public final String getFullName() {
 		if (parent==null) return getName();
-		final StringBuilder sb=new StringBuilder(parent.getFullName());
-		sb.append('.');
-		sb.append(getName());
-		if ((getAddress()==null)||(getAddress().length==0)) return sb.toString();
-		sb.append(getAddress()[parent.getLevel()]);
-		return sb.toString();
+		return parent.getFullName()+'.'+getName();
 	}
 
 	/**
diff --git a/JSimpleSim/src/org/simplesim/model/RoutingDomain.java b/JSimpleSim/src/org/simplesim/model/RoutingDomain.java
@@ -111,14 +111,16 @@ public void setAsRootDomain() {
 	 * during a simulation cycle.
 	 *
 	 * @param entity the model to be added
+	 * @return the given entity for further usage
 	 * @throws UniqueConstraintViolationException if the entity is already part of this domain
 	 * @throws NullPointerException               if entity is null
 	 */
 	@Override
-	public final void addEntity(BasicModelEntity entity) {
+	public final <T extends BasicModelEntity> T addEntity(T entity) {
 		super.addEntity(entity);
 		entity.getOutport().connectTo(getOutport()); // establish connection towards domain root
 		entity.resetAddress(countDomainEntities()-1); // reset addresses in entity and its children
+		return entity;
 	}
 
 	/**
@@ -131,7 +133,7 @@ public final void addEntity(BasicModelEntity entity) {
 	 * @return the removed entity if the domain contained it, null otherwise
 	 */
 	@Override
-	public final BasicModelEntity removeEntity(BasicModelEntity entity) {
+	public final <T extends BasicModelEntity> T removeEntity(T entity) {
 		final int start=getEntityList().indexOf(entity);
 		if (start==-1) return null; // unknown entity
 		getEntityList().remove(start);
diff --git a/JSimpleSim/src/org/simplesim/strategy/AATest.java b/JSimpleSim/src/org/simplesim/strategy/AATest.java
diff --git a/JSimpleSim/src/org/simplesim/strategy/AspirationAdaptation.java b/JSimpleSim/src/org/simplesim/strategy/AspirationAdaptation.java
diff --git a/JSimpleSim/src/org/simplesim/strategy/package-info.java b/JSimpleSim/src/org/simplesim/strategy/package-info.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/**`
	`1`	`+/*`
`2`	`2`	`* JSimpleSim is a framework to build multi-agent systems in a quick and easy`
`3`	`3`	`* way.`
`4`	`4`	`*`