org.onosproject.net.topology

Class GeoDistanceLinkWeight

java.lang.Object

org.onosproject.net.topology.GeoDistanceLinkWeight

All Implemented Interfaces:

EdgeWeigher<TopologyVertex,TopologyEdge>, LinkWeigher

public class GeoDistanceLinkWeight
extends Object
implements LinkWeigher

Link weight for measuring link cost using the geo distance between link vertices as determined by the element longitude/latitude annotation.

Constructor Summary

Constructors

Constructor and Description
GeoDistanceLinkWeight(DeviceService deviceService) Creates a new link-weight with access to the specified device service.

Method Summary

Modifier and Type	Method and Description
Weight	getInitialWeight() Returns initial weight value (i.e.
Weight	getNonViableWeight() Returns weight of a link/path that should be skipped (can be considered as an infinite weight).
Weight	weight(TopologyEdge edge) Returns the weight of the given edge.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoDistanceLinkWeight

public GeoDistanceLinkWeight(DeviceService deviceService)

Creates a new link-weight with access to the specified device service.

Parameters:

deviceService - device service reference

Method Detail

getInitialWeight

public Weight getInitialWeight()

Description copied from interface: EdgeWeigher

Returns initial weight value (i.e. weight of a "path" starting and terminating in the same vertex; typically 0 value is used).

Specified by:

getInitialWeight in interface EdgeWeigher<TopologyVertex,TopologyEdge>

Returns:

null path weight

getNonViableWeight

public Weight getNonViableWeight()

Description copied from interface: EdgeWeigher

Returns weight of a link/path that should be skipped (can be considered as an infinite weight).

Specified by:

getNonViableWeight in interface EdgeWeigher<TopologyVertex,TopologyEdge>

Returns:

non viable weight

weight

public Weight weight(TopologyEdge edge)

Description copied from interface: EdgeWeigher

Returns the weight of the given edge.

Specified by:

weight in interface EdgeWeigher<TopologyVertex,TopologyEdge>

Parameters:

edge - edge to be weighed

Returns:

edge weight