Implementing requested changes.

Author: staudtMarius

docs/readthedocs/models/result/grid/congestion.md

@@ -19,6 +19,10 @@ Representation of a congestion result for a given subnet.
    * - time
      - ZonedDateTime
      - date and time for the produced result
+   
+   * - subgrid
+     - --
+     - Sub grid number
 
    * - vMin
      - p.u.

src/main/java/edu/ie3/datamodel/io/factory/result/CongestionResultFactory.java

@@ -17,7 +17,7 @@
 import tech.units.indriya.ComparableQuantity;
 
 public class CongestionResultFactory extends ResultEntityFactory<CongestionResult> {
-  private static final String SUBNET = "subnet";
+  private static final String SUBGRID = "subgrid";
   private static final String VMIN = "vMin";
   private static final String VMAX = "vMax";
   private static final String VOLTAGE = "voltage";
@@ -34,13 +34,13 @@ public CongestionResultFactory(DateTimeFormatter dateTimeFormatter) {
 
   @Override
   protected List<Set<String>> getFields(Class<?> entityClass) {
-    return List.of(newSet(TIME, SUBNET, VMIN, VMAX, VOLTAGE, LINE, TRANSFORMER));
+    return List.of(newSet(TIME, SUBGRID, VMIN, VMAX, VOLTAGE, LINE, TRANSFORMER));
   }
 
   @Override
   protected CongestionResult buildModel(EntityData data) {
     ZonedDateTime zdtTime = timeUtil.toZonedDateTime(data.getField(TIME));
-    int subnet = data.getInt(SUBNET);
+    int subnet = data.getInt(SUBGRID);
     ComparableQuantity<Dimensionless> vMin = data.getQuantity(VMIN, PU);
     ComparableQuantity<Dimensionless> vMax = data.getQuantity(VMAX, PU);
     boolean voltage = data.getBoolean(VOLTAGE);

src/main/java/edu/ie3/datamodel/models/result/CongestionResult.java

@@ -12,7 +12,7 @@
 
 public class CongestionResult extends ResultEntity {
   /** Values */
-  private final Integer subnet;
+  private final Integer subgrid;
 
   private final ComparableQuantity<Dimensionless> vMin;
   private final ComparableQuantity<Dimensionless> vMax;
@@ -24,7 +24,7 @@ public class CongestionResult extends ResultEntity {
    * Standard constructor which includes auto generation of the resulting output models uuid.
    *
    * @param time date and time when the result is produced
-   * @param subnet the subnet
+   * @param subgrid the subgrid
    * @param vMin minimum voltage in pu
    * @param vMax maximal voltage in pu
    * @param voltage {@code true} if a voltage congestion occurred in the subnet
@@ -33,23 +33,23 @@ public class CongestionResult extends ResultEntity {
    */
   public CongestionResult(
       ZonedDateTime time,
-      int subnet,
+      int subgrid,
       ComparableQuantity<Dimensionless> vMin,
       ComparableQuantity<Dimensionless> vMax,
       boolean voltage,
       boolean line,
       boolean transformer) {
     super(time);
-    this.subnet = subnet;
+    this.subgrid = subgrid;
     this.vMin = vMin;
     this.vMax = vMax;
     this.voltage = voltage;
     this.line = line;
     this.transformer = transformer;
   }
 
-  public int getSubnet() {
-    return subnet;
+  public int getSubgrid() {
+    return subgrid;
   }
 
   public boolean getVoltage() {
@@ -78,6 +78,7 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) return false;
     CongestionResult that = (CongestionResult) o;
     return getTime().equals(that.getTime())
+        && Objects.equals(subgrid, that.subgrid)
         && vMin.equals(that.vMin)
         && vMax.equals(that.vMax)
         && voltage == that.voltage
@@ -87,13 +88,16 @@ public boolean equals(Object o) {
 
   @Override
   public int hashCode() {
-    return Objects.hash(super.hashCode(), getTime(), vMin, vMax, voltage, line, transformer);
+    return Objects.hash(
+        super.hashCode(), getTime(), subgrid, vMin, vMax, voltage, line, transformer);
   }
 
   @Override
   public String toString() {
     return "InputResultEntity{time="
         + getTime()
+        + ", subgrid="
+        + subgrid
         + ", vMin="
         + vMin
         + ", vMan="

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

@@ -13,7 +13,6 @@
 import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import edu.ie3.datamodel.models.result.CongestionResult;
 import edu.ie3.datamodel.models.result.ModelResultEntity;
-import edu.ie3.datamodel.models.result.ResultEntity;
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
 import edu.ie3.datamodel.models.value.WeatherValue;
 import edu.ie3.datamodel.utils.Try;
@@ -32,7 +31,7 @@ public class UniquenessValidationUtils extends ValidationUtils {
   protected static final FieldSetSupplier<ModelResultEntity> modelResultFieldSupplier =
       entity -> Set.of(entity.getTime(), entity.getInputModel());
   protected static final FieldSetSupplier<CongestionResult> congestionResultFieldSupplier =
-      entity -> Set.of(entity.getTime(), entity.getSubnet());
+      entity -> Set.of(entity.getTime(), entity.getSubgrid());
   protected static final FieldSetSupplier<MappingEntry> mappingFieldSupplier =
       entity -> Set.of(entity.participant());
   protected static final FieldSetSupplier<IdCoordinateInput> idCoordinateSupplier =
@@ -73,7 +72,7 @@ public static void checkAssetUniqueness(Collection<? extends AssetInput> entitie
   }
 
   /**
-   * Checks the uniqueness of a collection of {@link ResultEntity}.
+   * Checks the uniqueness of a collection of {@link CongestionResult}.
    *
    * @param entities to be checked
    * @throws DuplicateEntitiesException if uniqueness is violated