Package org.opendaylight.algo.impl

Class CspfPath

java.lang.Object

org.opendaylight.algo.impl.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	CspfPath.CspfPathStatus

Constructor Summary

Constructors

Constructor	Description
CspfPath(CspfPath path)
CspfPath(ConnectedVertex source, ConnectedVertex vertex)

Method Summary

Modifier and Type	Method	Description
CspfPath	addConnectedEdge(ConnectedEdge edge)
CspfPath	addPath(List<ConnectedEdge> list)
void	clearPath()
int	compareTo(CspfPath other)
boolean	equals(Object object)
int	getCost()
int	getDelay()
Integer	getKey()
List<ConnectedEdge>	getPath()
int	getPathCount()
float	getPathLength()
Long	getPredecessor()
ConnectedVertex	getSource()
CspfPath.CspfPathStatus	getStatus()
ConnectedVertex	getVertex()
Long	getVertexKey()
int	hashCode()
CspfPath	replacePath(List<ConnectedEdge> list)
CspfPath	setCost(int cost)
CspfPath	setDelay(int delay)
CspfPath	setKey(Integer key)
CspfPath	setPathLength(float length)
CspfPath	setPredecessor(Long vertexId)
CspfPath	setStatus(CspfPath.CspfPathStatus status)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CspfPath

public CspfPath(ConnectedVertex source,
 ConnectedVertex vertex)

CspfPath

public CspfPath(CspfPath path)

Method Details

getVertex

public ConnectedVertex getVertex()

getSource

public ConnectedVertex getSource()

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(ConnectedEdge edge)

addPath

public CspfPath addPath(List<ConnectedEdge> list)

replacePath

public CspfPath replacePath(List<ConnectedEdge> list)

getPath

public List<ConnectedEdge> getPath()

getPathCount

public int getPathCount()

setStatus

public CspfPath setStatus(CspfPath.CspfPathStatus status)

getStatus

public CspfPath.CspfPathStatus getStatus()

setPredecessor

public CspfPath setPredecessor(Long vertexId)

getPredecessor

public Long getPredecessor()

setPathLength

public CspfPath setPathLength(float length)

getPathLength

public float getPathLength()

clearPath

public void clearPath()

setKey

public CspfPath setKey(Integer key)

getKey

public Integer getKey()

compareTo

public int compareTo(CspfPath other)

Specified by:

compareTo in interface Comparable<CspfPath>

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object