com.yworks.yfiles.layout.router.polyline

Class PathSearchConfiguration

java.lang.Object

com.yworks.yfiles.layout.router.polyline.PathSearchConfiguration

public class PathSearchConfiguration
extends Object

This class contains the basic configuration used by path search algorithms.

Constructor Summary

Constructors

Constructor and Description
PathSearchConfiguration(LayoutGraph graph, GroupingSupport grouping, EdgeRouter edgeRouter) Creates a new instance of PathSearchConfiguration used for a path search.

Method Summary

Modifier and Type	Method and Description
EdgeRouter	getEdgeRouter() Gets the edge routing algorithm using this configuration.
LayoutGraph	getGraph() Gets the graph containing the edges whose path is searched.
GroupingSupport	getGrouping() Gets the grouping information of the graph.
long	getRemainingTime() Gets the remaining time (in milliseconds) within which the algorithm should complete its calculation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathSearchConfiguration

public PathSearchConfiguration(LayoutGraph graph,
                               GroupingSupport grouping,
                               EdgeRouter edgeRouter)

Creates a new instance of PathSearchConfiguration used for a path search.

Parameters:

graph - the graph containing the edges whose path will be searched

grouping - the grouping information of the graph

edgeRouter - the edge routing algorithm using this configuration

Method Detail

getEdgeRouter

public EdgeRouter getEdgeRouter()

Gets the edge routing algorithm using this configuration.

Returns:

the edge routing algorithm using this configuration

getGraph

public LayoutGraph getGraph()

Gets the graph containing the edges whose path is searched.

Returns:

the current graph

getGrouping

public GroupingSupport getGrouping()

Gets the grouping information of the graph.

Returns:

the grouping information of the graph

getRemainingTime

public long getRemainingTime()

Gets the remaining time (in milliseconds) within which the algorithm should complete its calculation.

Returns:

the remaining time for the calculation