org.opentrafficsim.core.network.route

Class CompleteRoute<LINKID,NODEID>

java.lang.Object

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

org.opentrafficsim.core.network.route.CompleteRoute<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

public class CompleteRoute<LINKID,NODEID>
extends Route<LINKID,NODEID>

A CompleteRoute is a Route with directly connected 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-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

Constructor Summary

Constructors

Constructor and Description
CompleteRoute(String id) Create an empty route.
CompleteRoute(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.
boolean	containsLink(Link<LINKID,NODEID> link) Determine if this Route contains the specified Link.

Methods inherited from class org.opentrafficsim.core.network.route.Route

destinationNode, getId, getNode, getNodes, indexOf, originNode, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteRoute

public CompleteRoute(String id)

Create an empty route.

Parameters:

id - the name of the route.

CompleteRoute

public CompleteRoute(String id,
                     List<Node<NODEID>> nodes)
              throws NetworkException

Create a route based on an initial list of nodes.
This constructor makes a defensive copy of the provided List.

Parameters:

id - the name of the route.

nodes - the initial list of nodes.

Throws:

NetworkException - if intermediate nodes are missing in the route.

Method Detail

addNode

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

Add a node to the end of the node list.

Overrides:

addNode in class Route<LINKID,NODEID>

Parameters:

node - the node to add.

Throws:

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

containsLink

public final boolean containsLink(Link<LINKID,NODEID> link)

Determine if this Route contains the specified Link.

Parameters:

link - the link to check in the route.

Returns:

whether the link is part of the route or not.