Adding max delay parameter to em communication.

Author: staudtMarius

src/main/java/edu/ie3/simona/api/data/connection/ExtEmDataConnection.java

@@ -12,7 +12,9 @@
 import edu.ie3.simona.api.data.model.em.FlexOptions;
 import edu.ie3.simona.api.ontology.em.*;
 import java.util.*;
+import javax.measure.quantity.Time;
 import org.slf4j.Logger;
+import tech.units.indriya.ComparableQuantity;
 
 /** Enables data connection of em data between SIMONA and SimonaAPI */
 public final class ExtEmDataConnection
@@ -23,18 +25,35 @@ public final class ExtEmDataConnection
   /** Assets that are controlled by external simulation */
   private final List<UUID> controlled;
 
+  private final Optional<ComparableQuantity<Time>> maxDelay;
+
   public ExtEmDataConnection(List<UUID> controlled, EmMode mode) {
     super();
 
     this.mode = mode;
     this.controlled = controlled;
+    this.maxDelay = Optional.empty();
+  }
+
+  public ExtEmDataConnection(
+      List<UUID> controlled, EmMode mode, Optional<ComparableQuantity<Time>> maxDelay) {
+    super();
+
+    this.mode = mode;
+    this.controlled = controlled;
+    this.maxDelay = maxDelay;
   }
 
   /** Returns a list of the uuids of the em agents that expect external set points */
   public List<UUID> getControlledEms() {
     return new ArrayList<>(controlled);
   }
 
+  /** Returns the maximal delay, that is allowed for a message when using the em communication. */
+  public Optional<ComparableQuantity<Time>> getMaxDelay() {
+    return maxDelay;
+  }
+
   /**
    * Sends the em flex requests to SIMONA.
    *

src/main/java/edu/ie3/simona/api/simulation/ExtCoSimulation.java

@@ -20,7 +20,9 @@
 import edu.ie3.simona.api.exceptions.ExtDataConnectionException;
 import edu.ie3.simona.api.mapping.DataType;
 import java.util.*;
+import javax.measure.quantity.Time;
 import org.slf4j.Logger;
+import tech.units.indriya.ComparableQuantity;
 
 /**
  * Abstract class for an external co-simulation with bidirectional communication with SIMONA.
@@ -72,11 +74,19 @@ public static ExtPrimaryDataConnection buildPrimaryConnection(
    * Builds an {@link ExtEmDataConnection}.
    *
    * @param controlled uuids for controlled em agents.
+   * @param maxDelay the maximal delay used in em communication mode
    * @param log logger
    * @return an ext em data connection
    */
   public static ExtEmDataConnection buildEmConnection(
-      List<UUID> controlled, ExtEmDataConnection.EmMode mode, Logger log) {
+      List<UUID> controlled,
+      ExtEmDataConnection.EmMode mode,
+      Optional<ComparableQuantity<Time>> maxDelay,
+      Logger log) {
+    if (maxDelay.isEmpty() && mode == ExtEmDataConnection.EmMode.EM_COMMUNICATION) {
+      log.info("Using em communication without a maximum delay.");
+    }
+
     if (controlled.isEmpty()) {
       log.warn("Em data connection with 0 controlled entities created. This might lead to errors!");
       throw new ExtDataConnectionException(ExtEmDataConnection.class);
@@ -86,7 +96,7 @@ public static ExtEmDataConnection buildEmConnection(
           mode,
           controlled.size());
 
-      return new ExtEmDataConnection(controlled, mode);
+      return new ExtEmDataConnection(controlled, mode, maxDelay);
     }
   }
 

src/test/groovy/edu/ie3/simona/api/simulation/ExtCoSimulationTest.groovy

@@ -50,15 +50,15 @@ class ExtCoSimulationTest extends Specification {
         def controlled = [uuid1, uuid2]
 
         when:
-        def actual = ExtCoSimulation.buildEmConnection(controlled, EmMode.BASE, log)
+        def actual = ExtCoSimulation.buildEmConnection(controlled, EmMode.BASE, Optional.empty(), log)
 
         then:
         actual.getControlledEms() == [uuid1, uuid2]
     }
 
     def "An ExtCoSimulation throws an ExtDataConnectionException while trying to build an empty em data connection"() {
         when:
-        ExtCoSimulation.buildEmConnection([], EmMode.BASE, log)
+        ExtCoSimulation.buildEmConnection([], EmMode.BASE, Optional.empty(), log)
 
         then:
         ExtDataConnectionException ex = thrown(ExtDataConnectionException)