Release 0.12.0

CHANGELOG.md

@@ -6,6 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.12.0] - 2025-11-20
+
+### Added
+- Adding some utility methods [#368](https://github.com/ie3-institute/simonaAPI/issues/368)
+- Extending flex option handling in `ExtInputContainer` [#371](https://github.com/ie3-institute/simonaAPI/issues/371)
+- Enhancing `ExtInputContainer` with `hasData` methods [#382](https://github.com/ie3-institute/simonaAPI/issues/382)
+
+### Changed
+- Changes to sent and received em data [#2366](https://github.com/ie3-institute/simonaAPI/issues/366)
+- Changed the PRated in the EvModel to SRated and added cosphi to the model [#259](https://github.com/ie3-institute/simonaAPI/issues/259)
+- Update `Gradle` to 9.2.0 [#381](https://github.com/ie3-institute/simonaAPI/issues/381)
+- Update `Gradle` to 9.2.1 [#389](https://github.com/ie3-institute/simonaAPI/issues/389)
+
+### Fixed
+- Issues related to em data [#366](https://github.com/ie3-institute/simonaAPI/issues/366)
+- `Fixed bugs in `ExtEntityMapping` [#373](https://github.com/ie3-institute/simonaAPI/issues/373)
+- Fixed changelog entry #366 [#378](https://github.com/ie3-institute/simonaAPI/issues/366)
+- Fix considered data in `ExtEntityMapping.getAssets()` [#384](https://github.com/ie3-institute/simonaAPI/issues/384)
+
 ## [0.11.0] - 2025-10-23
 
 ### Added

build.gradle

@@ -1,10 +1,10 @@
 plugins {
   id 'groovy' // groovy support
   id 'java' // java support
-  id 'com.diffplug.spotless' version '8.0.0'//code format
+  id 'com.diffplug.spotless' version '8.1.0'//code format
   id 'pmd' // code check, working on source code
-  id 'com.github.spotbugs' version '6.4.4' // code check, working on byte code
-  id "org.sonarqube" version "7.0.0.6105" // sonarqube
+  id 'com.github.spotbugs' version '6.4.5' // code check, working on byte code
+  id "org.sonarqube" version "7.0.1.6134" // sonarqube
   id 'signing'
   id 'maven-publish' // publish to a maven repo (local or mvn central, has to be defined)
   id 'jacoco' // java code coverage plugin
@@ -18,8 +18,8 @@ ext {
 
   // required for pekko
   scalaVersion = '3'
-  scalaBinaryVersion = '3.7.3'
-  pekkoVersion = "1.2.1"
+  scalaBinaryVersion = '3.7.4'
+  pekkoVersion = "1.3.0"
 }
 
 group = 'com.github.ie3-institute'

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 #
-# Copyright © 2015-2021 the original authors.
+# Copyright © 2015 the original authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -114,7 +114,6 @@ case "$( uname )" in                #(
   NONSTOP* )        nonstop=true ;;
 esac
 
-CLASSPATH="\\\"\\\""
 
 
 # Determine the Java command to use to start the JVM.
@@ -172,7 +171,6 @@ fi
 # For Cygwin or MSYS, switch paths to Windows format before running java
 if "$cygwin" || "$msys" ; then
     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
-    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
 
     JAVACMD=$( cygpath --unix "$JAVACMD" )
 
@@ -212,7 +210,6 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
-        -classpath "$CLASSPATH" \
         -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
         "$@"
 

gradlew.bat

@@ -70,11 +70,10 @@ goto fail
 :execute
 @rem Setup the command line
 
-set CLASSPATH=
 
 
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
 
 :end
 @rem End local scope for the variables with windows NT shell

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/connection/ExtEmDataConnection.java

@@ -9,6 +9,7 @@
 import edu.ie3.simona.api.data.model.em.*;
 import edu.ie3.simona.api.ontology.em.*;
 import java.util.*;
+import org.slf4j.Logger;
 
 /** Enables data connection of em data between SIMONA and SimonaAPI */
 public final class ExtEmDataConnection
@@ -32,42 +33,39 @@ public List<UUID> getControlledEms() {
   }
 
   /**
-   * Tries to send em data to SIMONA. A message is sent, if at least one map is not empty.
+   * Tries to send em data to SIMONA. A message is sent, if the map is not empty.
    *
    * @param tick current tick
-   * @param flexRequests receiver to flex option request
-   * @param flexOptions receiver to flex options
-   * @param setPoints receiver to set point
-   * @param maybeNextTick option for the next tick in the simulation
+   * @param emData a map: receiver to em data
+   * @param log logger for logging warnings
    * @return true, if data was sent
    */
-  public boolean sendEmData(
-      long tick,
-      Map<UUID, FlexOptionRequest> flexRequests,
-      Map<UUID, List<FlexOptions>> flexOptions,
-      Map<UUID, EmSetPoint> setPoints,
-      Optional<Long> maybeNextTick) {
+  public boolean sendEmData(long tick, Map<UUID, ? extends EmData> emData, Logger log) {
     // send message only if at least one value is present
-    if (!flexRequests.isEmpty() || !flexOptions.isEmpty() || !setPoints.isEmpty()) {
-      sendExtMsg(new ProvideEmData(tick, flexRequests, flexOptions, setPoints, maybeNextTick));
+    if (!emData.isEmpty()) {
+      sendExtMsg(ProvideEmData.create(tick, emData, log));
       return true;
     }
     return false;
   }
 
   /**
-   * Tries to send flex option requests to SIMONA. A message is sent, if at least one entity is
-   * given.
+   * Tries to send em data to SIMONA. A message is sent, if at least one map is not empty.
    *
    * @param tick current tick
-   * @param entities for which flex options should be requested
-   * @param disaggregated if disaggregated flex option should be returned
+   * @param flexRequests receiver to flex option request
+   * @param flexOptions receiver to flex options
+   * @param setPoints receiver to set point that should be sent to SIMONA
    * @return true, if data was sent
    */
-  public boolean sendFlexRequest(long tick, Collection<UUID> entities, boolean disaggregated) {
+  public boolean sendEmData(
+      long tick,
+      Map<UUID, FlexOptionRequest> flexRequests,
+      Map<UUID, List<FlexOptions>> flexOptions,
+      Map<UUID, EmSetPoint> setPoints) {
     // send message only if at least one value is present
-    if (!entities.isEmpty()) {
-      sendExtMsg(new RequestEmFlexResults(tick, new ArrayList<>(entities), disaggregated));
+    if (!flexRequests.isEmpty() || !flexOptions.isEmpty() || !setPoints.isEmpty()) {
+      sendExtMsg(new ProvideEmData(tick, flexRequests, flexOptions, setPoints));
       return true;
     }
     return false;
@@ -79,33 +77,13 @@ public boolean sendFlexRequest(long tick, Collection<UUID> entities, boolean dis
    *
    * @param tick current tick
    * @param emCommunicationMessages that should be sent
-   * @param maybeNextTick an option for the next tick
    * @return true, if data was sent
    */
   public boolean sendCommunicationMessage(
-      long tick,
-      List<EmCommunicationMessage<?>> emCommunicationMessages,
-      Optional<Long> maybeNextTick) {
+      long tick, List<EmCommunicationMessage<?>> emCommunicationMessages) {
     // send message only if at least one value is present
     if (!emCommunicationMessages.isEmpty()) {
-      sendExtMsg(new EmCommunicationMessages(tick, emCommunicationMessages, maybeNextTick));
-      return true;
-    }
-    return false;
-  }
-
-  /**
-   * Tries to send the em set points to SIMONA.
-   *
-   * @param tick current tick
-   * @param setPoints receiver to set point, that should be sent to SIMONA
-   * @param maybeNextTick option for the next tick in the simulation
-   * @return true, if data was sent
-   */
-  public boolean sendSetPoints(
-      long tick, Map<UUID, EmSetPoint> setPoints, Optional<Long> maybeNextTick) {
-    if (!setPoints.isEmpty()) {
-      sendExtMsg(new ProvideEmSetPointData(tick, setPoints, maybeNextTick));
+      sendExtMsg(new EmCommunicationMessages(tick, emCommunicationMessages));
       return true;
     }
     return false;
@@ -115,13 +93,18 @@ public boolean sendSetPoints(
    * Method to request em flexibility options from SIMONA.
    *
    * @param tick for which set points are requested
-   * @param emEntities for which set points are requested
-   * @return an {@link FlexOptionsResponse} message
+   * @param entities for which set points are requested
+   * @return a map: uuid to list of flex options
    * @throws InterruptedException - on interruptions
    */
-  public Map<UUID, ExtendedFlexOptionsResult> requestEmFlexResults(
-      long tick, List<UUID> emEntities, boolean disaggregated) throws InterruptedException {
-    sendExtMsg(new RequestEmFlexResults(tick, emEntities, disaggregated));
+  public Map<UUID, List<FlexOptions>> requestEmFlexResults(
+      long tick, List<UUID> entities, boolean disaggregated) throws InterruptedException {
+    // create requests
+    Map<UUID, FlexOptionRequest> requests = new HashMap<>();
+    entities.forEach(
+        emEntity -> requests.put(emEntity, new FlexOptionRequest(emEntity, disaggregated)));
+
+    sendExtMsg(new ProvideEmData(tick, requests, Collections.emptyMap(), Collections.emptyMap()));
     return receiveWithType(FlexOptionsResponse.class).receiverToFlexOptions();
   }
 

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

@@ -15,7 +15,7 @@
  * @param <T> type of response messages to ext
  */
 public sealed interface ExtOutputDataConnection<T extends DataResponseMessageToExt>
-    permits BiDirectional, ExtResultListener {
+    extends ExtDataConnection permits BiDirectional, ExtResultListener {
 
   /** Queues message from SIMONA that should be handled by the external simulation. */
   void queueExtResponseMsg(T msg) throws InterruptedException;

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

@@ -8,10 +8,7 @@
 
 import edu.ie3.datamodel.models.value.PValue;
 import edu.ie3.datamodel.models.value.Value;
-import edu.ie3.simona.api.data.model.em.EmCommunicationMessage;
-import edu.ie3.simona.api.data.model.em.EmSetPoint;
-import edu.ie3.simona.api.data.model.em.FlexOptionRequest;
-import edu.ie3.simona.api.data.model.em.FlexOptions;
+import edu.ie3.simona.api.data.model.em.*;
 import java.util.*;
 
 /** Contains all inputs for SIMONA for a certain tick */
@@ -27,7 +24,7 @@ public final class ExtInputContainer implements ExtDataContainer {
   /** Map uuid to primary input value for SIMONA. */
   private final Map<UUID, Value> primaryData = new HashMap<>();
 
-  // mapping for em data
+  // mappings for em data
   /** Map uuid to flex option requests. */
   private final Map<UUID, FlexOptionRequest> flexRequests = new HashMap<>();
 
@@ -61,7 +58,8 @@ public boolean isEmpty() {
     return primaryData.isEmpty()
         && flexRequests.isEmpty()
         && flexOptions.isEmpty()
-        && setPoints.isEmpty();
+        && setPoints.isEmpty()
+        && emMessages.isEmpty();
   }
 
   /** Returns the tick the data is provided for. */
@@ -74,6 +72,19 @@ public Optional<Long> getMaybeNextTick() {
     return maybeNextTick;
   }
 
+  /** Returns {@code true} if this container holds primary data. */
+  public boolean hasPrimaryData() {
+    return !primaryData.isEmpty();
+  }
+
+  /** Returns {@code true} if this container holds em data. */
+  public boolean hasEmData() {
+    return !flexRequests.isEmpty()
+        || !flexOptions.isEmpty()
+        || !setPoints.isEmpty()
+        || !emMessages.isEmpty();
+  }
+
   // add data
 
   /**
@@ -100,8 +111,34 @@ public void addRequest(UUID receiver) {
     flexRequests.put(receiver, new FlexOptionRequest(receiver, false));
   }
 
-  public void addRequest(UUID receiver, FlexOptionRequest request) {
-    flexRequests.put(receiver, request);
+  /**
+   * Method for adding a flex option request.
+   *
+   * @param request to be added
+   */
+  public void addRequest(FlexOptionRequest request) {
+    flexRequests.put(request.receiver(), request);
+  }
+
+  /**
+   * Method for adding flex options to a given receiver.
+   *
+   * @param multiFlexOptions that will be added to this container
+   */
+  public void addFlexOptions(MultiFlexOptions multiFlexOptions) {
+    flexOptions
+        .computeIfAbsent(multiFlexOptions.receiver(), k -> new ArrayList<>())
+        .addAll(multiFlexOptions.disaggregated().values());
+  }
+
+  /**
+   * Method for adding flex options to a given receiver.
+   *
+   * @param receiver that will receive the flex options
+   * @param flexOption that will be added
+   */
+  public void addFlexOptions(UUID receiver, FlexOptions flexOption) {
+    flexOptions.computeIfAbsent(receiver, k -> new ArrayList<>()).add(flexOption);
   }
 
   /**
@@ -201,4 +238,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
+        + '}';
+  }
 }