Merge pull request #370 from ie3-institute/ms/#368-adding-utility-methods

Adding utility methods

Author: staudtMarius

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+- Adding some utility methods [#368](https://github.com/ie3-institute/simonaAPI/issues/368)
+
 ### Changed
 - Changes to sent and received em data [#2366](https://github.com/ie3-institute/simonaAPI/issues/366)
 

src/main/java/edu/ie3/simona/api/data/ExtDataContainerQueue.java

@@ -21,6 +21,11 @@ public int size() {
     return receiverTriggerDeque.size();
   }
 
+  /** Method for clearing this queue. */
+  public void clear() {
+    receiverTriggerDeque.clear();
+  }
+
   /**
    * Method for adding an {@link ExtDataContainer} to the queue.
    *

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

@@ -9,6 +9,8 @@
 import edu.ie3.simona.api.exceptions.UnexpectedResponseMessageException;
 import edu.ie3.simona.api.ontology.DataMessageFromExt;
 import edu.ie3.simona.api.ontology.DataResponseMessageToExt;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.concurrent.LinkedBlockingQueue;
 
 /**
@@ -38,6 +40,13 @@ public final R receiveAny() throws InterruptedException {
     return receiveTriggerQueue.take();
   }
 
+  /** Returns all received responses. */
+  public final List<R> receiveAll() {
+    List<R> result = new ArrayList<>(receiveTriggerQueue.size());
+    receiveTriggerQueue.drainTo(result);
+    return result;
+  }
+
   @Override
   @SuppressWarnings("unchecked")
   public final <T extends R> T receiveWithType(Class<T> expectedMessageClass)

src/main/java/edu/ie3/simona/api/data/container/ExtInputContainer.java

@@ -201,4 +201,24 @@ public String flexOptionsString() {
   public String setPointsString() {
     return setPoints.toString();
   }
+
+  @Override
+  public String toString() {
+    return "ExtInputContainer{"
+        + "tick="
+        + tick
+        + ", maybeNextTick="
+        + maybeNextTick
+        + ", primaryData="
+        + primaryData
+        + ", flexRequests="
+        + flexRequests
+        + ", flexOptions="
+        + flexOptions
+        + ", setPoints="
+        + setPoints
+        + ", emMessages="
+        + emMessages
+        + '}';
+  }
 }

src/main/java/edu/ie3/simona/api/data/container/ExtOutputContainer.java

@@ -135,4 +135,18 @@ public List<ResultEntity> getResult(UUID assetId) {
   public List<EmData> getEmData(UUID assetId) {
     return emDataMap.getOrDefault(assetId, Collections.emptyList());
   }
+
+  @Override
+  public String toString() {
+    return "ExtOutputContainer{"
+        + "tick="
+        + tick
+        + ", maybeNextTick="
+        + maybeNextTick
+        + ", resultMap="
+        + resultMap
+        + ", emDataMap="
+        + emDataMap
+        + '}';
+  }
 }

src/main/java/edu/ie3/simona/api/ontology/results/ProvideResultEntities.java

@@ -19,4 +19,8 @@ public record ProvideResultEntities(Map<UUID, List<ResultEntity>> results)
   public ProvideResultEntities(List<ResultEntity> resultEntities) {
     this(resultEntities.stream().collect(Collectors.groupingBy(ResultEntity::getInputModel)));
   }
+
+  public ProvideResultEntities(ResultEntity result) {
+    this(Map.of(result.getInputModel(), List.of(result)));
+  }
 }