Route (Open Traffic Sim core classes 0.02.01 API)

java.lang.Object
- org.opentrafficsim.core.network.route.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.
The Node type in the list has generic parameters. This requires callers of getNode(), visitNextNode(), etc. to cast the result as needed. and permits inclusion mixed types of Nodes in one Route.
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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static DoubleScalar.Rel<LengthUnit>`	`GETOFFTHISLANENOW` Return value of suitability when a lane change is required right now.
`static DoubleScalar.Rel<LengthUnit>`	`NOLANECHANGENEEDED` Return value of suitability when no lane change is required withing the time horizon.

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.

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

All Methods Instance Methods Concrete 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)` Determine if this Route contains the specified Link.
`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()`
`DoubleScalar.Rel<LengthUnit>`	`suitability(Lane lane, DoubleScalar.Rel<LengthUnit> longitudinalPosition, GTUType<?> gtuType, DoubleScalar.Rel<TimeUnit> timeHorizon)` Determine the suitability of being at a particular longitudinal position in a particular Lane for following this Route.
`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
  - NOLANECHANGENEEDED
```
public static final DoubleScalar.Rel<LengthUnit> NOLANECHANGENEEDED
```
    Return value of suitability when no lane change is required withing the time horizon.
  - GETOFFTHISLANENOW
```
public static final DoubleScalar.Rel<LengthUnit> GETOFFTHISLANENOW
```
    Return value of suitability when a lane change is required right now.
- 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.
    This constructor makes a defensive copy of the provided List.
    
    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)
```
    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.
  - 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.
    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;
  - suitability
```
public final DoubleScalar.Rel<LengthUnit> suitability(Lane lane,
                                                      DoubleScalar.Rel<LengthUnit> longitudinalPosition,
                                                      GTUType<?> gtuType,
                                                      DoubleScalar.Rel<TimeUnit> timeHorizon)
                                               throws NetworkException
```
    Determine the suitability of being at a particular longitudinal position in a particular Lane for following this Route.
    
    Parameters:
    
    lane - Lane; the lane to consider
    
    longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the longitudinal position in the lane
    
    gtuType - GTUType<?>; the type of the GTU (used to check lane compatibility of lanes)
    
    timeHorizon - DoubleScalar.Rel<TimeUnit>; the maximum time that a driver may want to look ahead
    
    Returns:
    
    DoubleScalar.Rel<LengthUnit>; a value that indicates within what distance the GTU should try to vacate this lane.
    
    Throws:
    
    NetworkException - on network inconsistency, or when the continuation Link at a branch cannot be determined
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Route

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOLANECHANGENEEDED

GETOFFTHISLANENOW

Constructor Detail

Route

Route

Method Detail

addNode

addNode

removeNode

getNode

originNode

size

destinationNode

lastVisitedNode

nextNodeToVisit

visitNextNode

containsLink

indexOf

suitability

toString