org.opentrafficsim.core.network.route

Interface RouteNavigator

All Superinterfaces:

Serializable

All Known Subinterfaces:

LaneBasedRouteNavigator

All Known Implementing Classes:

AbstractLaneBasedRouteNavigator, CompleteLaneBasedRouteNavigator, CompleteRouteNavigator

public interface RouteNavigator
extends Serializable

A RouteNavigator maintains a position on a route.

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-16 10:20:53 +0200 (Thu, 16 Jul 2015) $, @version $Revision: 1124 $, by $Author: pknoppers $, initial version Jul 22, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
Node	lastVisitedNode()
Node	nextNodeToVisit() This method does not advance the route pointer.
Node	visitNextNode() This method does advance the route pointer (if possible).

Method Detail

lastVisitedNode

Node lastVisitedNode()
              throws NetworkException

Returns:

the last visited node of the route, and null when no nodes have been visited yet.

Throws:

NetworkException - when the index is out of bounds (should never happen).

nextNodeToVisit

Node nextNodeToVisit()
              throws NetworkException

This method does not advance the route pointer.

Returns:

the next node of the route to visit, and null when we already reached the destination.

Throws:

NetworkException - when the index is out of bounds (should never happen).

visitNextNode

Node visitNextNode()
            throws NetworkException

This method does advance the route pointer (if possible).

Returns:

the next node of the route to visit, and null when we already reached the destination.

Throws:

NetworkException - when the index is out of bounds (should never happen).