DisjointPathPair (onlab-misc 1.3.0 API)

java.lang.Object
- org.onlab.graph.DisjointPathPair<V,E>

All Implemented Interfaces:: Edge<V>, Path<V,E>

public class DisjointPathPair<V extends Vertex,E extends Edge<V>>
extends Object
implements Path<V,E>

Field Summary

Fields
Modifier and Type Field and Description

Path<V,E> path1

Path<V,E> path2

Fields
Modifier and Type	Field and Description
`Path<V,E>`	`path1`
`Path<V,E>`	`path2`

Constructor Summary

Constructors
Constructor and Description

DisjointPathPair(Path<V,E> p1, Path<V,E> p2)
Creates a Disjoint Path Pair from two paths.

Constructors
Constructor and Description
`DisjointPathPair(Path<V,E> p1, Path<V,E> p2)` Creates a Disjoint Path Pair from two paths.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`cost()` Returns the total cost of the path as a unit-less number.
`V`	`dst()` Returns the edge destination vertex.
`List<E>`	`edges()` Returns the list of edges comprising the path.
`boolean`	`equals(Object obj)`
`boolean`	`hasBackup()` Checks if this path pair contains a backup/secondary path.
`int`	`hashCode()`
`int`	`size()` Returns number of paths inside this path pair object.
`V`	`src()` Returns the edge source vertex.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - path1
```
public Path<V extends Vertex,E extends Edge<V>> path1
```
  - path2
```
public Path<V extends Vertex,E extends Edge<V>> path2
```
- Constructor Detail
  - DisjointPathPair
```
public DisjointPathPair(Path<V,E> p1,
                        Path<V,E> p2)
```
    Creates a Disjoint Path Pair from two paths.
    
    Parameters:
    
    p1 - first path
    
    p2 - second path
- Method Detail
  - src
```
public V src()
```
    Description copied from interface: Edge
    
    Returns the edge source vertex.
    
    Specified by:
    
    src in interface Edge<V extends Vertex>
    
    Returns:
    
    source vertex
  - dst
```
public V dst()
```
    Description copied from interface: Edge
    
    Returns the edge destination vertex.
    
    Specified by:
    
    dst in interface Edge<V extends Vertex>
    
    Returns:
    
    destination vertex
  - cost
```
public double cost()
```
    Description copied from interface: Path
    
    Returns the total cost of the path as a unit-less number.
    
    Specified by:
    
    cost in interface Path<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    path cost as a unit-less number
  - edges
```
public List<E> edges()
```
    Description copied from interface: Path
    
    Returns the list of edges comprising the path. Adjacent edges will share the same vertex, meaning that a source of one edge, will be the same as the destination of the prior edge.
    
    Specified by:
    
    edges in interface Path<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    list of path edges
  - hasBackup
```
public boolean hasBackup()
```
    Checks if this path pair contains a backup/secondary path.
    
    Returns:
    
    boolean representing whether it has backup
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - size
```
public int size()
```
    Returns number of paths inside this path pair object.
    
    Returns:
    
    number of paths

Class DisjointPathPair<V extends Vertex,E extends Edge<V>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

path1

path2

Constructor Detail

DisjointPathPair

Method Detail

src

dst

cost

edges

hasBackup

toString

hashCode

equals

size