org.opentripplanner.routing.algorithm.strategies

Class MultiTargetTerminationStrategy

java.lang.Object

org.opentripplanner.routing.algorithm.strategies.MultiTargetTerminationStrategy

All Implemented Interfaces:

SearchTerminationStrategy

public class MultiTargetTerminationStrategy
extends Object
implements SearchTerminationStrategy

A termination strategy that terminates after multiple targets have been reached. Useful for implementing a restricted batch search - i.e. doing one-to-many search without building a full shortest path tree.

Author:

avi

Constructor Summary

Constructors

Constructor and Description
MultiTargetTerminationStrategy(Set<Vertex> targets)

Method Summary

Modifier and Type	Method and Description
boolean	shouldSearchTerminate(Vertex origin, Vertex target, State current, ShortestPathTree spt, RoutingRequest traverseOptions) Updates the list of reached targets and returns True if all the targets have been reached.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiTargetTerminationStrategy

public MultiTargetTerminationStrategy(Set<Vertex> targets)

Method Detail

shouldSearchTerminate

public boolean shouldSearchTerminate(Vertex origin,
                                     Vertex target,
                                     State current,
                                     ShortestPathTree spt,
                                     RoutingRequest traverseOptions)

Updates the list of reached targets and returns True if all the targets have been reached.

Specified by:

shouldSearchTerminate in interface SearchTerminationStrategy

Parameters:

origin - the origin vertex

target - the target vertex, may be null in an undirected search

current - the current shortest path tree vertex

spt - the current shortest path tree

traverseOptions - the traverse options

Returns:

true if the specified search should be terminated