[68][164] Activation used LDevice and Deactivation unused LDevice

Signed-off-by: Aliou DIAITE <aliou.diaite@rte-france.com>
Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ResumedDataTemplate.java

@@ -322,4 +322,11 @@ public void setValImport(boolean valImport) {
     public boolean isValImport(){
         return daName.isValImport();
     }
+
+    public ResumedDataTemplate setNewVal(String daiValue) {
+        TVal newDaiVal = new TVal();
+        newDaiVal.setValue(daiValue);
+        this.setDaiValues(List.of(newDaiVal));
+        return this;
+    }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/SclReport.java

@@ -0,0 +1,40 @@
+/*
+ * // SPDX-FileCopyrightText: 2022 RTE FRANCE
+ * //
+ * // SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.lfenergy.compas.sct.commons.dto;
+
+import lombok.*;
+import org.lfenergy.compas.sct.commons.scl.SclRootAdapter;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Setter
+@Getter
+@Builder
+public class SclReport {
+
+    private SclRootAdapter scdFile;
+
+    private List<ErrorDescription> errorDescriptionList = new ArrayList<>();
+
+    public boolean isSuccess() {
+        return errorDescriptionList.isEmpty();
+    }
+
+    @Getter
+    @Setter
+    @AllArgsConstructor
+    @ToString
+    @EqualsAndHashCode
+    @Builder
+    public static class ErrorDescription{
+        private String xpath;
+        private String message;
+    }
+}

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/LDeviceActivation.java

@@ -0,0 +1,131 @@
+// SPDX-FileCopyrightText: 2022 RTE FRANCE
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.sct.commons.scl;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.apache.commons.lang3.tuple.Pair;
+import org.lfenergy.compas.scl2007b4.model.TCompasLDeviceStatus;
+import org.lfenergy.compas.sct.commons.dto.ResumedDataTemplate;
+import org.lfenergy.compas.sct.commons.util.STValEnum;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Common class for all states that define if LDevice should be activated or Not
+ * regardless of the CompasLDeviceStatus, Enum Values and if it's referenced in Substation...LNode or Not
+ */
+@Getter
+@Setter
+public class LDeviceActivation {
+
+    private final List<Pair<String, String>> iedNameLdInstList;
+
+    private TCompasLDeviceStatus compasLDeviceStatus;
+    private boolean isUpdatable;
+    private ResumedDataTemplate resumedDataTemplate;
+    private List<String> errorMessages = new ArrayList<>();
+
+    public LDeviceActivation(List<Pair<String, String>> iedNameLdInstList) {
+        this.iedNameLdInstList = iedNameLdInstList;
+    }
+
+    /**
+     * check whether LDevice Status is authorized to be activated or Not
+     * @param iedName Ied name value which LDevice appear
+     * @param ldInst LDevice inst value
+     * @param compasLDeviceStatus Private value
+     * @param enumValues enum values
+     */
+    public void checkLDeviceActivationStatus(String iedName, String ldInst, TCompasLDeviceStatus compasLDeviceStatus, Set<String> enumValues) {
+        if (!enumValues.contains(STValEnum.ON.value) && !enumValues.contains(STValEnum.OFF.value)) {
+            errorMessages.add(String.format("Unexpected error: The IED@%s/LDevice@%s cannot be activated or desactivated because its BehaviourKind Enum contains NOT 'on' AND NOT 'off'.",
+                    iedName, ldInst));
+        }
+        if (!enumValues.contains(STValEnum.ON.value) && enumValues.contains(STValEnum.OFF.value)) {
+            if (isAuthorized(iedName, ldInst)) {
+                errorMessages.add(String.format("Unexpected error: The IED@%s/LDevice@%s cannot be set to 'on' but has been selected into SSD: this case should not occur.",
+                        iedName, ldInst));
+            } else {
+                isUpdatable = true;
+                resumedDataTemplate.setNewVal(STValEnum.OFF.value);
+            }
+        }
+        if(compasLDeviceStatus.equals(TCompasLDeviceStatus.ACTIVE) ||
+                compasLDeviceStatus.equals(TCompasLDeviceStatus.UNTESTED)){
+            isAuthorizedToActivateLDevice(iedName, ldInst, enumValues);
+        }
+        if(compasLDeviceStatus.equals(TCompasLDeviceStatus.INACTIVE)){
+            isAuthorizedToDeactivateLDevice(iedName, ldInst, enumValues);
+        }
+    }
+
+    /**
+     * check whether LDevice Status is authorized to be activated when CompasLDeviceStatus Private is ACTIVE or UNTESTED
+     * @param iedName Ied name value which LDevice appear
+     * @param ldInst LDevice inst value
+     * @param enumValues enum values
+     */
+    private void isAuthorizedToActivateLDevice(String iedName, String ldInst, Set<String> enumValues) {
+        if (!enumValues.contains(STValEnum.OFF.value) && enumValues.contains(STValEnum.ON.value)) {
+            if (isAuthorized(iedName, ldInst)) {
+                isUpdatable = true;
+                resumedDataTemplate.setNewVal(STValEnum.ON.value);
+            } else {
+                errorMessages.add(String.format("Unexpected error: The IED@%s/LDevice@%s cannot be set to 'off' but has not been selected into SSD: this case should not occur.",
+                        iedName, ldInst));
+            }
+        }
+        if (enumValues.contains(STValEnum.ON.value) && enumValues.contains(STValEnum.OFF.value)) {
+            isUpdatable = true;
+            if (isAuthorized(iedName, ldInst)) {
+                resumedDataTemplate.setNewVal(STValEnum.ON.value);
+            } else {
+                resumedDataTemplate.setNewVal(STValEnum.OFF.value);
+            }
+        }
+
+    }
+
+    /**
+     * check whether LDevice Status is authorized to be deactivated when CompasLDeviceStatus Private is INACTIVE
+     * @param iedName Ied name value which LDevice appear
+     * @param ldInst LDevice inst value
+     * @param enumValues enum values
+     */
+    private void isAuthorizedToDeactivateLDevice(String iedName, String ldInst, Set<String> enumValues) {
+        if (!enumValues.contains(STValEnum.OFF.value) && enumValues.contains(STValEnum.ON.value)) {
+            if (isAuthorized(iedName, ldInst)) {
+                errorMessages.add(String.format("Unexpected error: The IED@%s/LDevice@%s is not qualified into STD but has been selected into SSD: this case should not occur.",
+                        iedName, ldInst));
+            } else {
+                errorMessages.add(String.format("Unexpected error: The IED@%s/LDevice@%s cannot be set to 'off' but has not been selected into SSD: this case should not occur.",
+                        iedName, ldInst));
+            }
+        }
+        if (enumValues.contains(STValEnum.ON.value) && enumValues.contains(STValEnum.OFF.value)) {
+            if (isAuthorized(iedName, ldInst)) {
+                errorMessages.add(String.format("Unexpected error: The IED@%s/LDevice@%s is not qualified into STD but has been selected into SSD: this case should not occur.",
+                        iedName, ldInst));
+            } else {
+                isUpdatable = true;
+                resumedDataTemplate.setNewVal(STValEnum.OFF.value);
+            }
+        }
+    }
+
+    /**
+     * @param iedName Ied name value
+     * @param ldInst LDevice inst value
+     * @return Returns whether a pair of IED name and LDevice inst are referenced in Substation...LNode list
+     */
+    private boolean isAuthorized(String iedName, String ldInst){
+        return iedNameLdInstList.contains(Pair.of(iedName, ldInst));
+    }
+
+
+}

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/SclElementAdapter.java

@@ -67,6 +67,12 @@ protected boolean amRootElement(){
         return parentAdapter == null;
     }
 
+    /**
+     * Returns XPath path to current element
+     * @return message as <em>undefined</em>
+     */
+    protected abstract String elementXPath();
+
     protected void customInit() {
         // do nothing
     }
@@ -109,12 +115,4 @@ public String getXPath(){
         return parentXpath + "/" + elementXPath();
     }
 
-    /**
-     * Returns XPath path to current element
-     * @return message as <em>undefined</em>
-     */
-    protected String elementXPath(){
-        return String.format("undefined(%s)", currentElem.getClass().getSimpleName());
-    }
-
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/SclRootAdapter.java

@@ -18,6 +18,7 @@
 import org.lfenergy.compas.sct.commons.scl.sstation.SubstationAdapter;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 /**
@@ -140,6 +141,19 @@ public SubstationAdapter getSubstationAdapter(String ssName) throws ScdException
         return new SubstationAdapter(this,ssName);
     }
 
+    /**
+     * Gets the first Substation from SCL root node
+     * @return <em>SubstationAdapter</em> object
+     * @throws ScdException throws when unknown Substation
+     */
+    public SubstationAdapter getSubstationAdapter() throws ScdException {
+        TSubstation tSubstation = currentElem.getSubstation()
+                .stream()
+                .findFirst()
+                .orElseThrow(() -> new ScdException("No Substation in SCL file"));
+        return new SubstationAdapter(this, tSubstation);
+    }
+
     /**
      * Add Header to SCL root node
      * @param hId SCL Header ID
@@ -275,4 +289,5 @@ public IEDAdapter checkObjRef(String val) throws ScdException {
         }
         throw new ScdException("Invalid ObjRef: " + val);
     }
+
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/SclService.java

@@ -18,6 +18,7 @@
 import org.lfenergy.compas.sct.commons.scl.dtt.LNodeTypeAdapter;
 import org.lfenergy.compas.sct.commons.scl.header.HeaderAdapter;
 import org.lfenergy.compas.sct.commons.scl.ied.*;
+import org.lfenergy.compas.sct.commons.scl.sstation.SubstationAdapter;
 import org.lfenergy.compas.sct.commons.util.Utils;
 
 import java.util.*;
@@ -680,4 +681,28 @@ public static void removeAllControlBlocksAndDatasetsAndExtRefSrcBindings(final S
                 .forEach(LNAdapter::removeAllControlBlocksAndDatasets);
     }
 
+     /**
+     * Activate used LDevice and Deactivate unused LDevice in {@link TLNode <em><b>TLNode </b></em>}
+     * @param scd SCL file for which LDevice should be activated or deactivated
+     * @return SclReport Object that contain SCL file and set of errors
+     */
+    public static SclReport updateLDeviceStatus(SCL scd) {
+        SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
+        SubstationAdapter substationAdapter = sclRootAdapter.getSubstationAdapter();
+        final List<Pair<String, String>> iedNameLdInstList = substationAdapter.getLDevicesFromLNode(true);
+        LDeviceActivation lDeviceActivation = new LDeviceActivation(iedNameLdInstList);
+        List<SclReport.ErrorDescription> errors = sclRootAdapter.getIEDAdapters().stream()
+                .map(IEDAdapter::getLDeviceAdapters)
+                .flatMap(Collection::stream)
+                .map(LDeviceAdapter::getLN0Adapter)
+                .map(ln0Adapter -> ln0Adapter.checkAndUpdateLDeviceStatus(lDeviceActivation))
+                .reduce(new ArrayList<>(),(sclReportErrors, partialSclReportErrors) -> {
+                    sclReportErrors.addAll(partialSclReportErrors);
+                    return sclReportErrors;
+                });
+        SclReport sclReport = new SclReport();
+        sclReport.getErrorDescriptionList().addAll(errors);
+        sclReport.setScdFile(sclRootAdapter);
+        return sclReport;
+     }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/SubstationService.java

@@ -14,7 +14,6 @@
 import org.lfenergy.compas.sct.commons.scl.sstation.SubstationAdapter;
 import org.lfenergy.compas.sct.commons.scl.sstation.VoltageLevelAdapter;
 
-
 /**
  * A representation of the <em><b>{@link SubstationService SubstationService}</b></em>.
  * <p>

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/com/CommunicationAdapter.java

@@ -58,6 +58,11 @@ public boolean amChildElementRef() {
         return currentElem == parentAdapter.getCurrentElem().getCommunication();
     }
 
+    @Override
+    protected String elementXPath() {
+        return "Communication";
+    }
+
     /**
      * Add Subnetwork node in Communication one.
      * For that :

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/com/ConnectedAPAdapter.java

@@ -6,8 +6,8 @@
 
 import org.lfenergy.compas.scl2007b4.model.SCL;
 import org.lfenergy.compas.scl2007b4.model.TConnectedAP;
-import org.lfenergy.compas.scl2007b4.model.TPrivate;
 import org.lfenergy.compas.sct.commons.scl.SclElementAdapter;
+import org.lfenergy.compas.sct.commons.util.Utils;
 
 import java.util.Optional;
 
@@ -45,6 +45,13 @@ protected boolean amChildElementRef() {
         return parentAdapter.getCurrentElem().getConnectedAP().contains(currentElem);
     }
 
+    @Override
+    protected String elementXPath() {
+        return String.format("ConnectedAP[%s and %s]",
+                Utils.xpathAttributeFilter("apName", currentElem.isSetApName() ? currentElem.getApName() : null),
+                Utils.xpathAttributeFilter("iedName", currentElem.isSetIedName() ? currentElem.getApName() : null));
+    }
+
     /**
      * Returns the value of the <em><b>iedName</b></em> attribute.
      * @return the value of the <em><b>iedName</b></em> attribute.

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/com/SubNetworkAdapter.java

@@ -9,6 +9,7 @@
 import org.lfenergy.compas.scl2007b4.model.TSubNetwork;
 import org.lfenergy.compas.sct.commons.exception.ScdException;
 import org.lfenergy.compas.sct.commons.scl.SclElementAdapter;
+import org.lfenergy.compas.sct.commons.util.Utils;
 
 import java.util.List;
 import java.util.Objects;
@@ -48,6 +49,12 @@ protected boolean amChildElementRef() {
         return parentAdapter.getCurrentElem().getSubNetwork().contains(currentElem);
     }
 
+    @Override
+    protected String elementXPath() {
+        return String.format("SubNetwork[%s]",
+                Utils.xpathAttributeFilter("name", currentElem.isSetName() ? currentElem.getName() : null));
+    }
+
     /**
      * Create a Connected Access Point for this subnetwork.<br/>
      * <p>

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/dtt/DAAdapter.java

@@ -8,6 +8,7 @@
 import org.lfenergy.compas.scl2007b4.model.TDA;
 import org.lfenergy.compas.sct.commons.dto.DaTypeName;
 import org.lfenergy.compas.sct.commons.exception.ScdException;
+import org.lfenergy.compas.sct.commons.util.Utils;
 
 /**
  * A representation of the model object <em><b>{@link org.lfenergy.compas.scl2007b4.model.TDA DA}</b></em>.
@@ -57,6 +58,13 @@ protected boolean amChildElementRef() {
         return parentAdapter.getCurrentElem().getSDOOrDA().contains(currentElem);
     }
 
+    @Override
+    protected String elementXPath() {
+        return String.format("DA[name=%s and type=%s]",
+                Utils.xpathAttributeFilter("name", currentElem.isSetName() ? currentElem.getName() : null),
+                Utils.xpathAttributeFilter("type", currentElem.isSetType() ? currentElem.getType() : null));
+    }
+
     /**
      * Updates DA Type Name
      * @param daTypeName DA Type Name to update