Fix CI Cent OS 8 configuration issue (workaround)
[transportpce.git] / pce / src / main / java / org / opendaylight / transportpce / pce / networkanalyzer / PceLink.java
index 408c6c822e679c62a88c9de9f175f3a2c677d78a..eafec51153810bbe3219b4b0b1323d9de0ccc026 100644 (file)
@@ -8,22 +8,17 @@
 
 package org.opendaylight.transportpce.pce.networkanalyzer;
 
 
 package org.opendaylight.transportpce.pce.networkanalyzer;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.Serializable;
 import java.io.Serializable;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.List;
 import java.util.Map;
+import org.opendaylight.transportpce.common.NetworkUtils;
 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.networkutils.rev220630.OtnLinkType;
 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.networkutils.rev220630.OtnLinkType;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Link1;
 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.span.attributes.LinkConcatenation1;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.span.attributes.LinkConcatenation1.FiberType;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.link.oms.attributes.Span;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmLinkType;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenation;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenationKey;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev230526.networks.network.link.oms.attributes.Span;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev230526.OpenroadmLinkType;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
@@ -32,7 +27,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @SuppressWarnings("serial")
 import org.slf4j.LoggerFactory;
 
 @SuppressWarnings("serial")
-@edu.umd.cs.findbugs.annotations.SuppressFBWarnings(
+@SuppressFBWarnings(
     value = "SE_NO_SERIALVERSIONID",
     justification = "https://github.com/rzwitserloot/lombok/wiki/WHY-NOT:-serialVersionUID")
 public class PceLink implements Serializable {
     value = "SE_NO_SERIALVERSIONID",
     justification = "https://github.com/rzwitserloot/lombok/wiki/WHY-NOT:-serialVersionUID")
 public class PceLink implements Serializable {
@@ -48,7 +43,8 @@ public class PceLink implements Serializable {
 
     // this member is for XPONDER INPUT/OUTPUT links.
     // it keeps name of client corresponding to NETWORK TP
 
     // this member is for XPONDER INPUT/OUTPUT links.
     // it keeps name of client corresponding to NETWORK TP
-    private String client = "";
+    private String clientA = "";
+    private String clientZ = "";
     private final LinkId linkId;
     private final OpenroadmLinkType linkType;
     private final NodeId sourceId;
     private final LinkId linkId;
     private final OpenroadmLinkType linkType;
     private final NodeId sourceId;
@@ -66,16 +62,12 @@ public class PceLink implements Serializable {
     private final Long availableBandwidth;
     private final Long usedBandwidth;
     private final List<Long> srlgList;
     private final Long availableBandwidth;
     private final Long usedBandwidth;
     private final List<Long> srlgList;
-//    private final double osnr;
     private final Double length;
     private final Double cd;
     private final Double pmd2;
     private final Double spanLoss;
     private final Double powerCorrection;
     private final transient Span omsAttributesSpan;
     private final Double length;
     private final Double cd;
     private final Double pmd2;
     private final Double spanLoss;
     private final Double powerCorrection;
     private final transient Span omsAttributesSpan;
-    //meter per ms
-    private static final double GLASSCELERITY = 2.99792458 * 1e5 / 1.5;
-    private static final double PMD_CONSTANT = 0.04;
 
     public PceLink(Link link, PceNode source, PceNode dest) {
         LOG.debug("PceLink: : PceLink start ");
 
     public PceLink(Link link, PceNode source, PceNode dest) {
         LOG.debug("PceLink: : PceLink start ");
@@ -103,15 +95,15 @@ public class PceLink implements Serializable {
         switch (this.linkType) {
             case ROADMTOROADM:
                 this.omsAttributesSpan = MapUtils.getOmsAttributesSpan(link);
         switch (this.linkType) {
             case ROADMTOROADM:
                 this.omsAttributesSpan = MapUtils.getOmsAttributesSpan(link);
-                this.length = calcLength(link);
+                this.length = NetworkUtils.calcLength(link);
                 this.srlgList = MapUtils.getSRLG(link);
                 this.srlgList = MapUtils.getSRLG(link);
-                this.latency = calcLatency(link);
+                this.latency = NetworkUtils.calcLatency(link);
                 this.availableBandwidth = 0L;
                 this.usedBandwidth = 0L;
                 this.availableBandwidth = 0L;
                 this.usedBandwidth = 0L;
-                Map<String, Double> spanLossMap = calcSpanLoss(link);
+                Map<String, Double> spanLossMap = NetworkUtils.calcSpanLoss(link);
                 this.spanLoss = spanLossMap.get("SpanLoss");
                 this.powerCorrection = spanLossMap.get("PoutCorrection");
                 this.spanLoss = spanLossMap.get("SpanLoss");
                 this.powerCorrection = spanLossMap.get("PoutCorrection");
-                Map<String, Double> cdAndPmdMap = calcCDandPMD(link);
+                Map<String, Double> cdAndPmdMap = NetworkUtils.calcCDandPMD(link);
                 this.cd = cdAndPmdMap.get("CD");
                 this.pmd2 = cdAndPmdMap.get("PMD2");
                 break;
                 this.cd = cdAndPmdMap.get("CD");
                 this.pmd2 = cdAndPmdMap.get("PMD2");
                 break;
@@ -153,188 +145,6 @@ public class PceLink implements Serializable {
         return tmpoppositeLink;
     }
 
         return tmpoppositeLink;
     }
 
-    //Compute the link latency : if the latency is not defined, the latency is computed from the length
-    private Long calcLatency(Link link) {
-        var augLinkLatency = link.augmentation(Link1.class).getLinkLatency();
-        if (augLinkLatency != null) {
-            return augLinkLatency.toJava();
-        }
-        Double linkLength = calcLength(link);
-        if (linkLength == null) {
-            LOG.debug("In PceLink: cannot compute the latency for the link {}", link.getLinkId().getValue());
-            return 1L;
-        }
-        LOG.debug("In PceLink: The latency of link {} is extrapolated from link length and == {}",
-            link.getLinkId(), linkLength / GLASSCELERITY);
-        return (long) Math.ceil(linkLength / GLASSCELERITY);
-    }
-
-    private Double calcLength(Link link) {
-        var augLinkLength = link.augmentation(Link1.class).getLinkLength();
-        if (augLinkLength != null) {
-            return augLinkLength.doubleValue();
-        }
-        if (this.omsAttributesSpan == null) {
-            LOG.debug("In PceLink: cannot compute the length for the link {}", link.getLinkId().getValue());
-            return null;
-        }
-        double linkLength = 0;
-        Map<LinkConcatenationKey, LinkConcatenation> linkConcatenationMap =
-            this.omsAttributesSpan.nonnullLinkConcatenation();
-        for (Map.Entry<LinkConcatenationKey, LinkConcatenation> entry : linkConcatenationMap.entrySet()) {
-            // Length is expressed in meter according to OpenROADM MSA
-            if (entry == null || entry.getValue() == null || entry.getValue().getSRLGLength() == null) {
-                LOG.debug("In PceLink: cannot compute the length for the link {}", link.getLinkId().getValue());
-                return null;
-            }
-            linkLength += entry.getValue().getSRLGLength().doubleValue();
-            LOG.debug("In PceLink: The length of the link {} == {}", link.getLinkId(), linkLength / 1000.0);
-        }
-        return linkLength / 1000.0;
-    }
-
-    //Calculate CD and PMD of the link from link length
-    private Map<String, Double> calcCDandPMDfromLength() {
-        return this.length == null
-            ? new HashMap<>()
-            : new HashMap<>(
-                Map.of(
-                    "CD", 16.5 * this.length,
-                    "PMD2", Math.pow(this.length * PMD_CONSTANT, 2)));
-    }
-
-    //Calculate CD and PMD of the link
-    private Map<String, Double> calcCDandPMD(Link link) {
-        double linkCd = 0.0;
-        double linkPmd2 = 0.0;
-        if (this.omsAttributesSpan == null) {
-            LOG.debug("In PceLink {} no OMS present, assume G.652 fiber, calculation based on fiber length of {} km",
-                link.getLinkId(), this.length);
-            return calcCDandPMDfromLength();
-        }
-        Map<LinkConcatenationKey, LinkConcatenation> linkConcatenationMap =
-            this.omsAttributesSpan.nonnullLinkConcatenation();
-        for (Map.Entry<LinkConcatenationKey, LinkConcatenation> entry : linkConcatenationMap.entrySet()) {
-            // If the link-concatenation list is not populated or partially populated CD &
-            // PMD shall be derived from link-length (expressed in km in OR topology)
-            if (entry == null || entry.getValue() == null || entry.getValue().getSRLGLength() == null
-                    || entry.getValue().augmentation(LinkConcatenation1.class).getFiberType() == null) {
-                if (this.length > 0.0) {
-                    LOG.debug("In PceLink: no OMS present; cd and PMD for the link {} extrapolated from link length {}"
-                        + "assuming SMF fiber type", link.getLinkId().getValue(), this.length);
-                    return calcCDandPMDfromLength();
-                }
-                // If Link-length upper attributes not present or incorrectly populated, no way
-                // to calculate CD & PMD
-                LOG.error("In PceLink: no Link length declared and no OMS present for the link {}."
-                    + " No Way to compute CD and PMD", link.getLinkId().getValue());
-                return Map.of();
-            }
-            // SRLG length is expressed in OR topology in meter
-            var entryAug = entry.getValue().augmentation(LinkConcatenation1.class);
-            linkCd += entry.getValue().getSRLGLength().doubleValue() / 1000.0
-                * retrieveCdFromFiberType(entryAug.getFiberType());
-            if (entryAug.getPmd() == null
-                    || entryAug.getPmd().getValue().doubleValue() == 0.0
-                    || entryAug.getPmd().getValue().toString().isEmpty()) {
-                linkPmd2 += Math.pow(
-                    entry.getValue().getSRLGLength().doubleValue() / 1000.0
-                        * retrievePmdFromFiberType(entryAug.getFiberType()),
-                    2);
-            } else {
-                linkPmd2 += Math.pow(entryAug.getPmd().getValue().doubleValue(), 2);
-            }
-        }
-        LOG.debug("In PceLink: The CD and PMD2 of link {} are respectively {} ps and {} ps",
-            link.getLinkId(), linkCd, linkPmd2);
-        return Map.of("CD", linkCd, "PMD2", linkPmd2);
-    }
-
-    // compute default spanLoss and power correction from fiber length
-    // when no OMS attribute defined
-    private Map<String, Double> calcDefaultSpanLoss(Link link) {
-        var augLinkLength = link.augmentation(Link1.class).getLinkLength();
-        if (augLinkLength == null || augLinkLength.doubleValue() == 0) {
-            LOG.error("In PceLink, no link length present or length declared = 0,"
-                + " unable to calculate default span Loss ");
-            return new HashMap<>();
-        }
-        long linkLength = augLinkLength.longValue();
-        LOG.warn("In PceLink {}, assume G.652 fiber, calculation "
-                + "based on fiber length of {} km and typical loss of 0.25dB per Km ",
-            link.getLinkId(), linkLength);
-        return new HashMap<>(
-            Map.of(
-                "SpanLoss", linkLength * 0.25,
-                "PoutCorrection", retrievePower(FiberType.Smf)
-            ));
-    }
-
-    // Compute the attenuation of a span from OMS attribute
-    private Map<String, Double> calcSpanLoss(Link link) {
-        if (this.omsAttributesSpan == null) {
-            return calcDefaultSpanLoss(link);
-        }
-        Collection<LinkConcatenation> linkConcatenationList =
-            this.omsAttributesSpan.nonnullLinkConcatenation().values();
-        if (linkConcatenationList == null) {
-            LOG.error("in PceLink : Null field in the OmsAttrubtesSpan");
-            return calcDefaultSpanLoss(link);
-        }
-        Iterator<LinkConcatenation> linkConcatenationiterator = linkConcatenationList.iterator();
-        if (!linkConcatenationiterator.hasNext()) {
-            return calcDefaultSpanLoss(link);
-        }
-        // Reference of power to be launched at input of ROADM (dBm)
-        return new HashMap<>(Map.of(
-            "PoutCorrection", retrievePower(
-                linkConcatenationiterator.next().augmentation(LinkConcatenation1.class).getFiberType()) - 2.0,
-            "SpanLoss", this.omsAttributesSpan.getSpanlossCurrent().getValue().doubleValue()));
-    }
-
-    private double retrievePower(FiberType fiberType) {
-        switch (fiberType) {
-            case Smf:
-                return 2;
-            case Eleaf:
-                return 1;
-            case Truewavec:
-                return -1;
-            case Oleaf:
-            case Dsf:
-            case Truewave:
-            case NzDsf:
-            case Ull:
-            default:
-                return 0;
-        }
-    }
-
-    private double retrievePmdFromFiberType(FiberType fiberType) {
-        return fiberType.toString().equalsIgnoreCase("Dsf")
-            ? 0.2
-            : PMD_CONSTANT;
-    }
-
-    private double retrieveCdFromFiberType(FiberType fiberType) {
-        switch (fiberType) {
-            case Dsf:
-                return 0.0;
-            case Truewavec:
-                return 3.0;
-            case Eleaf:
-            case Oleaf:
-            case NzDsf:
-                return 4.3;
-            case Truewave:
-                return 4.4;
-            case Smf:
-            case Ull:
-            default:
-                return 16.5;
-        }
-    }
-
     public LinkId getOppositeLink() {
         return oppositeLink;
     }
     public LinkId getOppositeLink() {
         return oppositeLink;
     }
@@ -371,16 +181,24 @@ public class PceLink implements Serializable {
         return destId;
     }
 
         return destId;
     }
 
-    public String getClient() {
-        return client;
+    public String getClientA() {
+        return clientA;
     }
 
     public Double getLength() {
         return length;
     }
 
     }
 
     public Double getLength() {
         return length;
     }
 
-    public void setClient(String client) {
-        this.client = client;
+    public void setClientA(String client) {
+        this.clientA = client;
+    }
+
+    public String getClientZ() {
+        return clientZ;
+    }
+
+    public void setClientZ(String client) {
+        this.clientZ = client;
     }
 
     // Double for transformer of JUNG graph
     }
 
     // Double for transformer of JUNG graph