org.opentrafficsim.core.network.route

Class CompleteRouteNavigator

java.lang.Object

org.opentrafficsim.core.network.route.CompleteRouteNavigator

All Implemented Interfaces:

Serializable, RouteNavigator

public class CompleteRouteNavigator
extends Object
implements RouteNavigator, Serializable

A CompleteRouteNavigator contains a complete route and maintains a position on the 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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CompleteRoute	completeRoute The complete route.
protected int	lastVisitedNodeIndex last visited node on the route.

Constructor Summary

Constructors

Constructor and Description
CompleteRouteNavigator(CompleteRoute completeRoute) Create a navigator.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

completeRoute

protected final CompleteRoute completeRoute

The complete route.

lastVisitedNodeIndex

protected int lastVisitedNodeIndex

last visited node on the route.

Constructor Detail

CompleteRouteNavigator

public CompleteRouteNavigator(CompleteRoute completeRoute)

Create a navigator.

Parameters:

completeRoute - the route to follow

Method Detail

lastVisitedNode

public final Node lastVisitedNode()
                           throws NetworkException

Specified by:

lastVisitedNode in interface RouteNavigator

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

public final Node nextNodeToVisit()
                           throws NetworkException

This method does not advance the route pointer.

Specified by:

nextNodeToVisit in interface RouteNavigator

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

public final Node visitNextNode()
                         throws NetworkException

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

Specified by:

visitNextNode in interface RouteNavigator

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).

getRoute

public final CompleteRoute getRoute()

Returns:

the (complete) route.

toString

public String toString()

Overrides:

toString in class Object