org.opentrafficsim.core.network.route

Class Route<LINKID,NODEID>

java.lang.Object

org.opentrafficsim.core.network.route.Route<LINKID,NODEID>

Type Parameters:

NODEID - the ID type of the Node, e.g., String.

LINKID - the ID type of the Link, e.g., String.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CompleteRoute

public class Route<LINKID,NODEID>
extends Object
implements Serializable

A Route consists of a list of Nodes.

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-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: averbraeck $, initial version Jan 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addNode(Node<NODEID> node) Add a node to the end of the node list.
Node<NODEID>	destinationNode()
String	getId()
Node<NODEID>	getNode(int i)
List<Node<NODEID>>	getNodes()
int	indexOf(Node<NODEID> node) Return the index of a Node in this Route, or -1 if this Route does not contain the specified Node.
Node<NODEID>	originNode()
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Route

public Route(String id)

Create an empty route.

Parameters:

id - the name of the route.

Route

public Route(String id,
             List<Node<NODEID>> nodes)

Create a route based on an initial list of nodes.

Parameters:

nodes - the initial list of nodes.

id - the name of the route.

Method Detail

addNode

public void addNode(Node<NODEID> node)
             throws NetworkException

Add a node to the end of the node list.

Parameters:

node - the node to add.

Throws:

NetworkException - in case node could not be added to the route.

getNodes

public final List<Node<NODEID>> getNodes()

Returns:

nodes.

getNode

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

Parameters:

i - the index of the node to obtain

Returns:

node i.

Throws:

NetworkException - if i < 0 or i > size

originNode

public final Node<NODEID> 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<NODEID> destinationNode()
                                   throws NetworkException

Returns:

the last node of the route.

Throws:

NetworkException - when the list has no nodes.

indexOf

public final int indexOf(Node<NODEID> node)

Return the index of a Node in this Route, or -1 if this Route does not contain the specified Node.
If this route contains the Node more than once, the index of the first is returned.

Parameters:

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

Returns:

int;

getId

public final String getId()

Returns:

name.

toString

public String toString()

Overrides:

toString in class Object