ch.awae.utils.pathfinding

Class AStarPathfinder<V>

java.lang.Object

ch.awae.utils.pathfinding.AStarPathfinder<V>

Type Parameters:

V - the vertex type of the path finder

All Implemented Interfaces:

Pathfinder<V>

public final class AStarPathfinder<V>
extends java.lang.Object
implements Pathfinder<V>

Path Finder based on the A-Star algorithm.

Since:

awaeUtils 1.0.2

Author:

Andreas Wälchli

Constructor Summary

Constructors

Constructor and Description
AStarPathfinder(GraphDataProvider<V> graph)

Method Summary

Modifier and Type	Method and Description
static <T> AStarPathfinder<T>	create(GraphDataProvider<T> graph)
PathfindingResult<V>	execute(V from, V to)
long	getTimeout() gets the currently set timeout value or 0 if timeouts are disabled.
void	setTimeout(long timeout) set a timeout for the pathfinding.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.awae.utils.pathfinding.Pathfinder

findPath

Constructor Detail

AStarPathfinder

public AStarPathfinder(GraphDataProvider<V> graph)

Method Detail

create

public static <T> AStarPathfinder<T> create(GraphDataProvider<T> graph)

setTimeout

public void setTimeout(long timeout)

Description copied from interface: Pathfinder

set a timeout for the pathfinding. when the timeout has been exceeded the pathfinder implementation must terminate and return null. By default timeouts are not supported and an UnsupportedOperationException is thrown.

Specified by:

setTimeout in interface Pathfinder<V>

Parameters:

timeout - the timeout in milliseconds. A value of 0 or less disables timeout.

getTimeout

public long getTimeout()

Description copied from interface: Pathfinder

gets the currently set timeout value or 0 if timeouts are disabled. By default timeouts are not supported and an UnsupportedOperationException is thrown.

Specified by:

getTimeout in interface Pathfinder<V>

Returns:

the current timeout in milliseconds.

execute

public PathfindingResult<V> execute(V from,
                                    V to)

Specified by:

execute in interface Pathfinder<V>