Add specific reports for equipment builders

Fix rebase

Signed-off-by: lisrte <[email protected]>

Author: Lisrte

commons/src/main/resources/com/powsybl/dynawo/commons/reports.properties

@@ -23,6 +23,7 @@ dynawo.dynasim.emptyAutomationSystem = ${automationSystemName} ${dynamicId} equi
 dynawo.dynasim.emptyList = '${fieldName}' list is empty
 dynawo.dynasim.emptyListAutomationSystem = None of ${automationSystemName} ${dynamicId} equipments are ${expectedModels}, the automation system will be skipped
 dynawo.dynasim.failedDynamicModelHandling = ${modelName} ${dynamicId} cannot handle ${equipmentType} dynamic model, the model will be skipped
+dynawo.dynasim.fictitiousEquipment = '${fieldName}' field value '${staticId}' should not be fictitious
 dynawo.dynasim.fieldConflict = Both '${firstFieldName}' and '${secondFieldName}' are defined, '${firstFieldName}' will be used
 dynawo.dynasim.fieldNotSet = '${fieldName}' field is not set
 dynawo.dynasim.fieldOptionNotImplemented = '${fieldName}' field is set but this option is not implemented yet, default value ${defaultValue} will be used
@@ -37,6 +38,7 @@ dynawo.dynasim.notEnergized = '${fieldName}' field value '${staticId}' should be
 dynawo.dynasim.outputVariableInstantiationError = Output variable ${id} cannot be instantiated
 dynawo.dynasim.staticIdUnknown = '${fieldName}' field value '${staticId}' not found for equipment type(s) ${equipmentType}, id will be used as pure dynamic model id
 dynawo.dynasim.unknownIdToDynamic = '${fieldName}' field value '${staticId}' not found for equipment type(s) ${equipmentType}
+dynawo.dynasim.wrongHvdcType = '${fieldName}' field value '${staticId}' should be an HVDC ${type}
 dynawo.dynasim.wrongNetwork = '${fieldName}' field value ${equipmentType} ${staticId} does not belong to the builder network
 dynawo.margincalc.loadsVariationInstantiationError = LoadVariation cannot be instantiated
 dynawo.margincalc.marginCalculationTool = Margin Calculation Tool

dynawo-dsl/src/test/java/com/powsybl/dynawo/dsl/DynamicModelsSupplierTest.java

@@ -264,7 +264,7 @@ private static Stream<Arguments> provideWarningsModel() {
                         + DSL tests
                            + Groovy Dynamic Models Supplier
                               + Model HvdcVsc L instantiation failed
-                                 'staticId' field value 'L' not found for equipment type(s) VSC HVDC_LINE
+                                 'staticId' field value 'L' should be an HVDC VSC
                         """)
                 );
     }

dynawo-simulation/src/main/java/com/powsybl/dynawo/builders/AbstractEquipmentModelBuilder.java

@@ -8,7 +8,9 @@
 package com.powsybl.dynawo.builders;
 
 import com.powsybl.commons.report.ReportNode;
-import com.powsybl.iidm.network.*;
+import com.powsybl.iidm.network.Identifiable;
+import com.powsybl.iidm.network.IdentifiableType;
+import com.powsybl.iidm.network.Network;
 
 import java.util.Objects;
 
@@ -24,7 +26,7 @@ public abstract class AbstractEquipmentModelBuilder<T extends Identifiable<?>, R
     protected AbstractEquipmentModelBuilder(Network network, ModelConfig modelConfig, IdentifiableType equipmentType, ReportNode reportNode) {
         super(network, reportNode);
         this.modelConfig = Objects.requireNonNull(modelConfig);
-        this.builderEquipment = new BuilderEquipment<>(equipmentType.toString());
+        this.builderEquipment = new BuilderEquipment<>(equipmentType);
     }
 
     protected AbstractEquipmentModelBuilder(Network network, ModelConfig modelConfig, String equipmentType, ReportNode reportNode) {
@@ -33,13 +35,6 @@ protected AbstractEquipmentModelBuilder(Network network, ModelConfig modelConfig
         this.builderEquipment = new BuilderEquipment<>(equipmentType);
     }
 
-    protected AbstractEquipmentModelBuilder(Network network, ModelConfig modelConfig, String equipmentType,
-                                            BuilderEquipment.EquipmentPredicate<T> equipmentPredicate, ReportNode reportNode) {
-        super(network, reportNode);
-        this.modelConfig = modelConfig;
-        this.builderEquipment = new BuilderEquipment<>(equipmentType, equipmentPredicate);
-    }
-
     @Override
     public R staticId(String staticId) {
         builderEquipment.addEquipment(staticId, this::findEquipment);
@@ -48,7 +43,7 @@ public R staticId(String staticId) {
 
     @Override
     public R equipment(T equipment) {
-        builderEquipment.addEquipment(equipment, network);
+        builderEquipment.addEquipment(equipment, eq -> Objects.equals(network, eq.getNetwork()));
         return self();
     }
 

dynawo-simulation/src/main/java/com/powsybl/dynawo/builders/BuilderEquipment.java

@@ -10,10 +10,9 @@
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.iidm.network.Identifiable;
 import com.powsybl.iidm.network.IdentifiableType;
-import com.powsybl.iidm.network.Network;
 
-import java.util.Objects;
 import java.util.function.Function;
+import java.util.function.Predicate;
 
 /**
  * Represents an equipment field identified by a static ID in a builder
@@ -23,57 +22,46 @@
  */
 public class BuilderEquipment<T extends Identifiable<?>> {
 
-    @FunctionalInterface
-    public interface EquipmentPredicate<T> {
-        boolean test(T equipment, String fieldName, ReportNode reportNode);
-    }
-
     private static final String DEFAULT_FIELD_NAME = "staticId";
+
     private static final String EQUIPMENT_FIELD_NAME = "equipment";
 
     protected boolean fromStaticId;
     protected String staticId;
     protected T equipment;
     private final String equipmentType;
     private final String fieldName;
-    private final EquipmentPredicate<T> equipmentPredicate;
 
-    public BuilderEquipment(String equipmentType, String fieldName, EquipmentPredicate<T> equipmentPredicate) {
+    public BuilderEquipment(String equipmentType, String fieldName) {
         this.equipmentType = equipmentType;
         this.fieldName = fieldName;
-        this.equipmentPredicate = equipmentPredicate;
     }
 
-    public BuilderEquipment(String equipmentType, EquipmentPredicate<T> equipmentPredicate) {
-        this(equipmentType, DEFAULT_FIELD_NAME, equipmentPredicate);
+    public BuilderEquipment(IdentifiableType identifiableType, String fieldName) {
+        this.equipmentType = identifiableType.toString();
+        this.fieldName = fieldName;
     }
 
-    public BuilderEquipment(String equipmentType, String fieldName) {
-        this(equipmentType, fieldName, (eq, f, r) -> true);
+    public BuilderEquipment(IdentifiableType identifiableType) {
+        this(identifiableType, DEFAULT_FIELD_NAME);
     }
 
     public BuilderEquipment(String equipmentType) {
         this(equipmentType, DEFAULT_FIELD_NAME);
     }
 
-    public BuilderEquipment(IdentifiableType identifiableType) {
-        this(identifiableType.toString());
-    }
-
-    public BuilderEquipment(IdentifiableType identifiableType, String fieldName) {
-        this(identifiableType.toString(), fieldName);
-    }
-
     public void addEquipment(String equipmentId, Function<String, T> equipmentSupplier) {
         fromStaticId = true;
         staticId = equipmentId;
         equipment = equipmentSupplier.apply(staticId);
     }
 
-    public void addEquipment(T equipment, Network network) {
+    public void addEquipment(T equipment, Predicate<T> equipmentChecker) {
         fromStaticId = false;
         staticId = equipment.getId();
-        this.equipment = Objects.equals(network, equipment.getNetwork()) ? equipment : null;
+        if (equipmentChecker.test(equipment)) {
+            this.equipment = equipment;
+        }
     }
 
     public boolean checkEquipmentData(ReportNode reportNode) {
@@ -88,7 +76,7 @@ public boolean checkEquipmentData(ReportNode reportNode) {
             }
             return false;
         }
-        return equipmentPredicate.test(equipment, fieldName, reportNode);
+        return true;
     }
 
     public String getStaticId() {
@@ -106,4 +94,8 @@ public T getEquipment() {
     public boolean hasEquipment() {
         return equipment != null;
     }
+
+    public String getFieldName() {
+        return fieldName;
+    }
 }

dynawo-simulation/src/main/java/com/powsybl/dynawo/builders/BuilderEquipmentsList.java

@@ -27,7 +27,7 @@ public class BuilderEquipmentsList<T extends Identifiable<?>> {
     private final boolean missingIdsHasDynamicIds;
     protected List<String> missingEquipmentIds = new ArrayList<>();
     protected List<T> equipments = new ArrayList<>();
-    private final BuilderEquipment.EquipmentPredicate<T> equipmentPredicate;
+    private final BuildersUtil.EquipmentPredicate<T> equipmentPredicate;
 
     public BuilderEquipmentsList(IdentifiableType identifiableType, String fieldName) {
         this(identifiableType.toString(), fieldName, false);
@@ -42,7 +42,7 @@ public BuilderEquipmentsList(String equipmentType, String fieldName, boolean mis
     }
 
     public BuilderEquipmentsList(String equipmentType, String fieldName, boolean missingIdsHasDynamicIds,
-                                 BuilderEquipment.EquipmentPredicate<T> equipmentPredicate) {
+                                 BuildersUtil.EquipmentPredicate<T> equipmentPredicate) {
         this.equipmentType = equipmentType;
         this.fieldName = fieldName;
         this.missingIdsHasDynamicIds = missingIdsHasDynamicIds;

dynawo-simulation/src/main/java/com/powsybl/dynawo/builders/BuilderIdListEquipmentList.java

@@ -18,7 +18,7 @@
  */
 public class BuilderIdListEquipmentList<T extends Identifiable<?>> extends BuilderEquipmentsList<T> {
 
-    public BuilderIdListEquipmentList(String equipmentType, String fieldName, BuilderEquipment.EquipmentPredicate<T> equipmentPredicate) {
+    public BuilderIdListEquipmentList(String equipmentType, String fieldName, BuildersUtil.EquipmentPredicate<T> equipmentPredicate) {
         super(equipmentType, fieldName, false, equipmentPredicate);
     }
 

dynawo-simulation/src/main/java/com/powsybl/dynawo/builders/BuilderReports.java

@@ -9,6 +9,7 @@
 
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.commons.report.TypedValue;
+import com.powsybl.iidm.network.HvdcConverterStation;
 import com.powsybl.iidm.network.IdentifiableType;
 
 /**
@@ -151,6 +152,26 @@ public static void reportFieldConflict(ReportNode reportNode, String firstFieldN
                 .add();
     }
 
+    public static void reportWrongHvdcType(ReportNode reportNode, String fieldName, String staticId,
+                                           HvdcConverterStation.HvdcType hvdcType) {
+        reportNode.newReportNode()
+                .withMessageTemplate("dynawo.dynasim.wrongHvdcType")
+                .withUntypedValue("type", hvdcType.toString())
+                .withUntypedValue(FIELD_NAME, fieldName)
+                .withUntypedValue(STATIC_ID, staticId)
+                .withSeverity(TypedValue.WARN_SEVERITY)
+                .add();
+    }
+
+    public static void reportFictitiousEquipment(ReportNode reportNode, String fieldName, String staticId) {
+        reportNode.newReportNode()
+                .withMessageTemplate("dynawo.dynasim.fictitiousEquipment")
+                .withUntypedValue(FIELD_NAME, fieldName)
+                .withUntypedValue(STATIC_ID, staticId)
+                .withSeverity(TypedValue.WARN_SEVERITY)
+                .add();
+    }
+
     public static void reportNotEnergized(ReportNode reportNode, String fieldName, String staticId) {
         reportNode.newReportNode()
                 .withMessageTemplate("dynawo.dynasim.notEnergized")

dynawo-simulation/src/main/java/com/powsybl/dynawo/builders/BuildersUtil.java

@@ -7,6 +7,7 @@
  */
 package com.powsybl.dynawo.builders;
 
+import com.powsybl.commons.report.ReportNode;
 import com.powsybl.iidm.network.*;
 
 import static com.powsybl.dynawo.models.utils.EnergizedUtils.isEnergized;
@@ -18,6 +19,26 @@ public final class BuildersUtil {
 
     public static final String MEASUREMENT_POINT_TYPE = IdentifiableType.BUS + "/" + IdentifiableType.BUSBAR_SECTION;
 
+    /**
+     * Verifies the ActionConnectionPoint (bus or busbar section) is energized and in main connected component
+     */
+    public static final EquipmentPredicate<Identifiable<?>> IS_ACTION_CONNECTION_POINT_ENERGIZED = (eq, f, r) -> {
+        boolean isEnergized = switch (eq.getType()) {
+            case BUS -> isEnergized((Bus) eq);
+            case BUSBAR_SECTION -> isEnergized((BusbarSection) eq);
+            default -> throw new UnsupportedOperationException("Only bus and bus bar section are supported");
+        };
+        if (!isEnergized) {
+            BuilderReports.reportNotEnergized(r, f, eq.getId());
+        }
+        return isEnergized;
+    };
+
+    @FunctionalInterface
+    public interface EquipmentPredicate<T> {
+        boolean test(T equipment, String fieldName, ReportNode reportNode);
+    }
+
     private BuildersUtil() {
     }
 

dynawo-simulation/src/main/java/com/powsybl/dynawo/models/automationsystems/TapChangerBlockingAutomationSystemBuilder.java

@@ -14,7 +14,7 @@
 
 import java.util.*;
 
-import static com.powsybl.dynawo.builders.BuildersUtil.IS_ENERGIZED;
+import static com.powsybl.dynawo.builders.BuildersUtil.IS_ACTION_CONNECTION_POINT_ENERGIZED;
 import static com.powsybl.dynawo.builders.BuildersUtil.MEASUREMENT_POINT_TYPE;
 
 /**
@@ -70,7 +70,7 @@ public static Collection<ModelInfo> getSupportedModelInfos(DynawoVersion dynawoV
     protected TapChangerBlockingAutomationSystemBuilder(Network network, ModelConfig modelConfig, ReportNode reportNode) {
         super(network, modelConfig, reportNode);
         tapChangerEquipments = new BuilderEquipmentsList<>(TAP_CHANGER_TYPE, TRANSFORMER_FIELD, true);
-        uMeasurementPoints = new BuilderIdListEquipmentList<>(MEASUREMENT_POINT_TYPE, U_MEASUREMENTS_FIELD, IS_ENERGIZED);
+        uMeasurementPoints = new BuilderIdListEquipmentList<>(MEASUREMENT_POINT_TYPE, U_MEASUREMENTS_FIELD, IS_ACTION_CONNECTION_POINT_ENERGIZED);
     }
 
     public TapChangerBlockingAutomationSystemBuilder transformers(String staticId) {

dynawo-simulation/src/main/java/com/powsybl/dynawo/models/hvdc/AbstractHvdcBuilder.java

@@ -40,6 +40,11 @@ public R dangling(TwoSides danglingSide) {
         return self();
     }
 
+    @Override
+    protected HvdcLine findEquipment(String staticId) {
+        return network.getHvdcLine(staticId);
+    }
+
     @Override
     protected void checkData() {
         super.checkData();

dynawo-simulation/src/main/java/com/powsybl/dynawo/models/hvdc/HvdcPBuilder.java

@@ -10,7 +10,6 @@
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.dynawo.builders.*;
 import com.powsybl.dynawo.commons.DynawoVersion;
-import com.powsybl.iidm.network.HvdcLine;
 import com.powsybl.iidm.network.IdentifiableType;
 import com.powsybl.iidm.network.Network;
 
@@ -65,11 +64,6 @@ protected HvdcPBuilder(Network network, ModelConfig modelConfig, ReportNode repo
         super(network, modelConfig, IdentifiableType.HVDC_LINE, reportNode, P_NAME_HANDLER);
     }
 
-    @Override
-    protected HvdcLine findEquipment(String staticId) {
-        return network.getHvdcLine(staticId);
-    }
-
     @Override
     protected HvdcPBuilder self() {
         return this;

dynawo-simulation/src/main/java/com/powsybl/dynawo/models/hvdc/HvdcVscBuilder.java

@@ -13,7 +13,6 @@
 import com.powsybl.iidm.network.*;
 
 import java.util.Collection;
-import java.util.function.Predicate;
 
 /**
  * @author Laurent Issertial {@literal <laurent.issertial at rte-france.com>}
@@ -23,7 +22,6 @@ public class HvdcVscBuilder extends AbstractHvdcBuilder<HvdcVscBuilder> {
     public static final String CATEGORY = "HVDC_VSC";
     private static final ModelConfigs MODEL_CONFIGS = ModelConfigsHandler.getInstance().getModelConfigs(CATEGORY);
     private static final HvdcVarNameHandler VSC_NAME_HANDLER = new VscVarNameHandler();
-    private static final Predicate<HvdcLine> IS_VSC = eq -> HvdcConverterStation.HvdcType.VSC == eq.getConverterStation1().getHvdcType();
 
     public static HvdcVscBuilder of(Network network) {
         return of(network, ReportNode.NO_OP);
@@ -63,13 +61,17 @@ public static Collection<ModelInfo> getSupportedModelInfos(DynawoVersion dynawoV
 
     protected HvdcVscBuilder(Network network, ModelConfig modelConfig, ReportNode reportNode) {
         super(network, modelConfig, "VSC " + IdentifiableType.HVDC_LINE, reportNode, VSC_NAME_HANDLER);
-        addEquipmentPredicate(IS_VSC);
     }
 
     @Override
-    protected HvdcLine findEquipment(String staticId) {
-        HvdcLine line = network.getHvdcLine(staticId);
-        return line != null && IS_VSC.test(line) ? line : null;
+    protected void checkData() {
+        super.checkData();
+        if (builderEquipment.hasEquipment() &&
+                HvdcConverterStation.HvdcType.VSC != getEquipment().getConverterStation1().getHvdcType()) {
+            BuilderReports.reportWrongHvdcType(reportNode, builderEquipment.getFieldName(), getModelId(),
+                    HvdcConverterStation.HvdcType.VSC);
+            isInstantiable = false;
+        }
     }
 
     @Override

dynawo-simulation/src/main/java/com/powsybl/dynawo/models/loads/AbstractLoadModelBuilder.java

@@ -9,7 +9,6 @@
 
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.dynawo.builders.AbstractEquipmentModelBuilder;
-import com.powsybl.dynawo.builders.BuilderEquipment;
 import com.powsybl.dynawo.builders.BuilderReports;
 import com.powsybl.dynawo.builders.ModelConfig;
 import com.powsybl.iidm.network.IdentifiableType;
@@ -21,20 +20,21 @@
  */
 public abstract class AbstractLoadModelBuilder<R extends AbstractEquipmentModelBuilder<Load, R>> extends AbstractEquipmentModelBuilder<Load, R> {
 
-    private static final BuilderEquipment.EquipmentPredicate<Load> IS_NOT_FICTITIOUS = (eq, f, r) -> {
-        if (eq.isFictitious()) {
-            BuilderReports.reportFictitiousEquipment(r, f, eq.getId());
-            return false;
-        }
-        return true;
-    };
-
     protected AbstractLoadModelBuilder(Network network, ModelConfig modelConfig, ReportNode reportNode) {
-        super(network, modelConfig, IdentifiableType.LOAD.toString(), IS_NOT_FICTITIOUS, reportNode);
+        super(network, modelConfig, IdentifiableType.LOAD, reportNode);
     }
 
     @Override
     protected Load findEquipment(String staticId) {
         return network.getLoad(staticId);
     }
+
+    @Override
+    protected void checkData() {
+        super.checkData();
+        if (builderEquipment.hasEquipment() && getEquipment().isFictitious()) {
+            BuilderReports.reportFictitiousEquipment(reportNode, builderEquipment.getFieldName(), getModelId());
+            isInstantiable = false;
+        }
+    }
 }