org.opentrafficsim.core.network

Class Route

java.lang.Object

org.opentrafficsim.core.network.Route

All Implemented Interfaces:

Serializable

public class Route
extends Object
implements Serializable

A Route consists of a list of Nodes. The last visited node is kept. Code can ask what the next node is, and can indicate the next node to visit. Routes can be expanded (e.g. for node expansion), collapsed (e.g. to use a macro model for a part of the route) or changed (e.g. to avoid congestion). Changing is done by adding and/or removing nodes of the node list. When the last visited node of the route is deleted, however, it is impossible to follow the route any further, which will result in a NetworkException.

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

Version:

Jan 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers FIXME: PK If this class is parameterized with the detailed Node type, no casts are needed when calling getNode(), visitNextNode, etc. and it will be impossible to insert Nodes of mixed types in the same Route.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Route() Create an empty route.
Route(List<Node<?,?>> nodes) Create a route based on an initial list of nodes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNode(int i, Node<?,?> node) Add a node at a specific location.
boolean	addNode(Node<?,?> node) Add a node to the end of the node list.
boolean	containsLink(CrossSectionLink<?,?> link) FIXME: this fails if this route contains a Node more than once.
Node<?,?>	destinationNode()
Node<?,?>	getNode(int i) Return a node at a specific location.
int	indexOf(Node<?,?> node) Return the index of a Node in this Route, or -1 if this Route does not contain the specified Node.
Node<?,?>	lastVisitedNode()
Node<?,?>	nextNodeToVisit() This method does not advance the route pointer.
Node<?,?>	originNode()
Node<?,?>	removeNode(int i) Remove a node from a specific location.
int	size()
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

Constructor Detail

Route

public Route()

Create an empty route.

Route

public Route(List<Node<?,?>> nodes)

Create a route based on an initial list of nodes.

Parameters:

nodes - the initial list of nodes.

Method Detail

addNode

public final boolean addNode(Node<?,?> node)
                      throws NetworkException

Add a node to the end of the node list.

Parameters:

node - the node to add.

Returns:

whether the add was successful.

Throws:

NetworkException - when node could not be added.

addNode

public final void addNode(int i,
           Node<?,?> node)
                   throws NetworkException

Add a node at a specific location.

Parameters:

i - the location to put the node (0-based).

node - the node to add.

Throws:

NetworkException - when i<0 or i>=nodes.size(). Also thrown when another error occurs.

removeNode

public final Node<?,?> removeNode(int i)
                           throws NetworkException

Remove a node from a specific location.

Parameters:

i - the location to remove the node from (0-based).

Returns:

the removed node.

Throws:

NetworkException - when i is equal to the last visited node because the next link on the route cannot be computed anymore. Also thrown when another error occurs.

getNode

public final Node<?,?> getNode(int i)
                        throws NetworkException

Return a node at a specific location.

Parameters:

i - the location to get the node from (0-based).

Returns:

the retrieved node.

Throws:

NetworkException - when i<0 or i>=nodes.size().

originNode

public final Node<?,?> originNode()
                           throws NetworkException

Returns:

the first node of the route.

Throws:

NetworkException - when the list has no nodes.

size

public final int size()

Returns:

the number of nodes in the list. If the list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

destinationNode

public final Node<?,?> destinationNode()
                                throws NetworkException

Returns:

the last node of the route.

Throws:

NetworkException - when the list has no nodes.

lastVisitedNode

public final 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

public final 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

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

containsLink

public final boolean containsLink(CrossSectionLink<?,?> link)

FIXME: this fails if this route contains a Node more than once.

Parameters:

link - the link to check in the route.

Returns:

whether the link is part of the route or not.

indexOf

public final int indexOf(Node<?,?> node)

Return the index of a Node in this Route, or -1 if this Route does not contain the specified Node. FIXME: this fails if this route contains a Node more than once.

Parameters:

node - Node<?, ?>; the Node to find

Returns:

int;

toString

public String toString()

Overrides:

toString in class Object