Extend Validation to EnergyManagement Systems

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+- Extend Validation to EnergyManagement Systems. [#1356](https://github.com/ie3-institute/PowerSystemDataModel/issues/1356)
+
 ### Fixed
 - Fixed handling of `CongestionResult.InputModelType` in `EntityProcessor` [#1325](https://github.com/ie3-institute/PowerSystemDataModel/issues/1325)
 - -Fixed em fields in input models [#1331](https://github.com/ie3-institute/PowerSystemDataModel/issues/1331)

src/main/java/edu/ie3/datamodel/utils/validation/EnergyManagementValidationUtils.java

@@ -0,0 +1,58 @@
+/*
+ * © 2021. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.utils.validation;
+
+import edu.ie3.datamodel.exceptions.InvalidEntityException;
+import edu.ie3.datamodel.exceptions.ValidationException;
+import edu.ie3.datamodel.models.input.EmInput;
+import edu.ie3.datamodel.utils.Try;
+import java.util.ArrayList;
+import java.util.List;
+
+public class EnergyManagementValidationUtils extends ValidationUtils {
+
+  /** Private Constructor as this class is not meant to be instantiated */
+  private EnergyManagementValidationUtils() {
+    throw new IllegalStateException("Don't try and instantiate a Utility class.");
+  }
+
+  /**
+   * Validates a energy management unit if:
+   *
+   * <ul>
+   *   <li>its control strategy is not null
+   *   <li>its control strategy matches the supported strategies
+   * </ul>
+   *
+   * A "distribution" method, that forwards the check request to specific implementations to fulfill
+   * the checking task, based on the class of the given object.
+   *
+   * @param energyManagement EmInput to validate
+   * @return a list of try objects either containing an {@link ValidationException} or an empty
+   *     Success
+   */
+  protected static List<Try<Void, ? extends ValidationException>> check(EmInput energyManagement) {
+    List<Try<Void, ? extends ValidationException>> exceptions = new ArrayList<>();
+
+    exceptions.add(
+        Try.ofVoid(
+            energyManagement.getControlStrategy() == null,
+            () ->
+                new InvalidEntityException(
+                    "No control strategy of energy management defined for", energyManagement)));
+
+    exceptions.add(
+        Try.ofVoid(
+            !(energyManagement.getControlStrategy().equals("PRIORITIZED")
+                || energyManagement.getControlStrategy().equals("PROPORTIONAL")),
+            () ->
+                new InvalidEntityException(
+                    "Control strategy of energy management system must be one of the following: PRIORITIZED, PROPORTIONAL.",
+                    energyManagement)));
+
+    return exceptions;
+  }
+}

src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java

@@ -5,12 +5,12 @@
 */
 package edu.ie3.datamodel.utils.validation;
 
-import edu.ie3.datamodel.exceptions.*;
+import edu.ie3.datamodel.exceptions.FailedValidationException;
+import edu.ie3.datamodel.exceptions.InvalidEntityException;
+import edu.ie3.datamodel.exceptions.UnsafeEntityException;
+import edu.ie3.datamodel.exceptions.ValidationException;
 import edu.ie3.datamodel.models.UniqueEntity;
-import edu.ie3.datamodel.models.input.AssetInput;
-import edu.ie3.datamodel.models.input.AssetTypeInput;
-import edu.ie3.datamodel.models.input.MeasurementUnitInput;
-import edu.ie3.datamodel.models.input.NodeInput;
+import edu.ie3.datamodel.models.input.*;
 import edu.ie3.datamodel.models.input.connector.ConnectorInput;
 import edu.ie3.datamodel.models.input.connector.type.LineTypeInput;
 import edu.ie3.datamodel.models.input.connector.type.Transformer2WTypeInput;
@@ -22,8 +22,11 @@
 import edu.ie3.datamodel.models.input.system.type.SystemParticipantTypeInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalUnitInput;
 import edu.ie3.datamodel.utils.Try;
-import edu.ie3.datamodel.utils.Try.*;
-import java.util.*;
+import edu.ie3.datamodel.utils.Try.Failure;
+import edu.ie3.datamodel.utils.Try.Success;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 import javax.measure.Quantity;
@@ -101,7 +104,7 @@
    * @return a list of try objects either containing a {@link ValidationException} or an empty
    *     Success
    */
   private static List<Try<Void, ? extends ValidationException>> checkAsset(AssetInput assetInput) {
     Try<Void, InvalidEntityException> isNull = checkNonNull(assetInput, "an asset");
 
     if (isNull.isFailure()) {
@@ -157,6 +160,8 @@
       exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));
     else if (ThermalGrid.class.isAssignableFrom(assetInput.getClass()))
       exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));
+    else if (EmInput.class.isAssignableFrom(assetInput.getClass()))
+      exceptions.addAll(EnergyManagementValidationUtils.check((EmInput) assetInput));
     else {
       logNotImplemented(assetInput);
     }

src/test/groovy/edu/ie3/datamodel/utils/validation/EmValidationUtilsTest.groovy

@@ -0,0 +1,41 @@
+/*
+ * © 2025. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+ */
+package edu.ie3.datamodel.utils.validation
+
+import edu.ie3.datamodel.exceptions.InvalidEntityException
+import edu.ie3.datamodel.exceptions.ValidationException
+import edu.ie3.datamodel.utils.Try
+import edu.ie3.test.common.GridTestData
+import spock.lang.Specification
+
+class EmValidationUtilsTest extends Specification {
+
+  def "Smoke Test: Correct energy management system throws no exception"() {
+    given:
+    def em = GridTestData.energyManagementInput
+
+    when:
+    List<Try<Void, ? extends ValidationException>> tries = EnergyManagementValidationUtils.check(em)
+
+    then:
+    tries.every { it.success }
+  }
+
+  def "The check method recognizes all potential errors for an energy management input"() {
+    when:
+    List<Try<Void, ? extends ValidationException>> exceptions = EnergyManagementValidationUtils.check(invalidEm).stream().filter { it -> it.failure }.toList()
+
+    then:
+    exceptions.size() == expectedSize
+    Exception ex = exceptions.get(0).exception.get()
+    ex.class == expectedException.class
+    ex.message == expectedException.message
+
+    where:
+    invalidEm                                                            	      || expectedSize || expectedException
+    GridTestData.energyManagementInput.copy().controlStrategy("invalid").build()  || 1            || new InvalidEntityException("Control strategy of energy management system must be one of the following: PRIORITIZED, PROPORTIONAL.", invalidEm)
+  }
+}

src/test/groovy/edu/ie3/test/common/GridTestData.groovy

@@ -9,6 +9,7 @@ import static edu.ie3.datamodel.models.StandardUnits.*
 import static edu.ie3.util.quantities.PowerSystemUnits.*
 
 import edu.ie3.datamodel.models.OperationTime
+import edu.ie3.datamodel.models.input.EmInput
 import edu.ie3.datamodel.models.input.MeasurementUnitInput
 import edu.ie3.datamodel.models.input.NodeInput
 import edu.ie3.datamodel.models.input.OperatorInput
@@ -387,4 +388,13 @@ class GridTestData {
   true,
   true
   )
+
+  public static final EmInput energyManagementInput = new EmInput(
+  UUID.fromString("4bef6955-5e31-4283-8920-5e4cae267a23"),
+  "test_energyManagement",
+  profBroccoli,
+  defaultOperationTime,
+  "PRIORITIZED",
+  null,
+  )
 }