Package org.opendaylight.algo.impl

Class CspfPath

  • All Implemented Interfaces:
    Comparable<CspfPath>
    public class CspfPath
extends Object
implements Comparable<CspfPath>
    This Class implements the Constrained Shortest Path First (CSPF) Path stored in the Priority Queue used by various Path Computation Algorithms.

    The path corresponds to the computed path between the Source Vertex and the Current Vertex. Cost (based on TE Metric) and Delay are accumulated values from the source to the current vertex.

    The class uses standard java "Comparable" interface to support "natural ordering" and thus implements the compareTo() method based on the "key" value. However, the equals() method uses Vertex Key for comparison. HashCode() method is also overridden by the Connected Vertex hashCode() method.

    Author:
    Olivier Dugeon

    • Constructor Detail

      • CspfPath

        public CspfPath​(org.opendaylight.graph.ConnectedVertex vertex)

    • Method Detail

      • getVertex

        public org.opendaylight.graph.ConnectedVertex getVertex()

      • getVertexKey

        public Long getVertexKey()

      • setCost

        public CspfPath setCost​(int cost)

      • getCost

        public int getCost()

      • setDelay

        public CspfPath setDelay​(int delay)

      • getDelay

        public int getDelay()

      • addConnectedEdge

        public CspfPath addConnectedEdge​(org.opendaylight.graph.ConnectedEdge edge)

      • replacePath

        public CspfPath replacePath​(List<org.opendaylight.graph.ConnectedEdge> list)

      • getPath

        public List<org.opendaylight.graph.ConnectedEdge> getPath()

      • getPathCount

        public int getPathCount()

      • setPathStatus

        public CspfPath setPathStatus​(byte status)

      • getPathStatus

        public byte getPathStatus()

      • setPredecessor

        public CspfPath setPredecessor​(Long vertexId)

      • getPredecessor

        public Long getPredecessor()

      • setPathLength

        public CspfPath setPathLength​(float length)

      • getPathLength

        public float getPathLength()

      • clearPath

        public void clearPath()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object