OTSNetwork (Open Traffic Sim core classes 0.02.03 API)

java.lang.Object
- org.opentrafficsim.core.network.OTSNetwork<NETWORKID,LINKID,NODEID>

Type Parameters:

NETWORKID - the ID type of the Network, e.g., String.

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

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

All Implemented Interfaces:

Serializable, Network<LINKID,NODEID>

Direct Known Subclasses:

ExpansionNetwork
```
public class OTSNetwork<NETWORKID,LINKID,NODEID>
extends Object
implements Network<LINKID,NODEID>, Serializable
```
A Network consists of a set of links. Each link has, in its turn, a start node and an end node.
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 Jul 22, 2015

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

OTSNetwork(NETWORKID id)
Construction of an empty network.

Constructors
Constructor and Description
`OTSNetwork(NETWORKID id)` Construction of an empty network.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLink(Link<LINKID,NODEID> link)`
`void`	`addNode(Node<NODEID> node)`
`void`	`addRoute(Route<LINKID,NODEID> route)`
`boolean`	`containsLink(Link<LINKID,NODEID> link)`
`boolean`	`containsLink(LINKID linkId)`
`boolean`	`containsNode(Node<NODEID> node)`
`boolean`	`containsNode(NODEID nodeId)`
`boolean`	`containsRoute(Route<LINKID,NODEID> route)`
`boolean`	`containsRoute(String routeId)`
`NETWORKID`	`getId()`
`Link<LINKID,NODEID>`	`getLink(LINKID linkId)`
`Link<LINKID,NODEID>`	`getLink(Node<NODEID> node1, Node<NODEID> node2)` Find a link between node1 and node2 and return it if it exists in the network.
`Link<LINKID,NODEID>`	`getLink(NODEID nodeId1, NODEID nodeId2)` Find a link between node1 and node2 and return it if it exists in the network.
`Map<LINKID,Link<LINKID,NODEID>>`	`getLinkMap()`
`Node<NODEID>`	`getNode(NODEID nodeId)`
`Map<NODEID,Node<NODEID>>`	`getNodeMap()`
`Route<LINKID,NODEID>`	`getRoute(String routeId)`
`Map<String,Route<LINKID,NODEID>>`	`getRouteMap()`
`Set<Route<LINKID,NODEID>>`	`getRoutesBetween(Node<NODEID> nodeFrom, Node<NODEID> nodeTo)`
`Route<LINKID,NODEID>`	`getShortestRouteBetween(Node<NODEID> nodeFrom, Node<NODEID> nodeTo)`
`void`	`removeLink(Link<LINKID,NODEID> link)`
`void`	`removeNode(Node<NODEID> node)`
`void`	`removeRoute(Route<LINKID,NODEID> route)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OTSNetwork
```
public OTSNetwork(NETWORKID id)
```
    Construction of an empty network.
    
    Parameters:
    
    id - the network id.
- Method Detail
  - addNode
```
public final void addNode(Node<NODEID> node)
                   throws NetworkException
```
    Specified by:
    
    addNode in interface Network<LINKID,NODEID>
    
    Parameters:
    
    node - the node to add to the network.
    
    Throws:
    
    NetworkException - if node already exists in the network, or if name of the node is not unique.
  - removeNode
```
public final void removeNode(Node<NODEID> node)
                      throws NetworkException
```
    Specified by:
    
    removeNode in interface Network<LINKID,NODEID>
    
    Parameters:
    
    node - the node to remove from the network.
    
    Throws:
    
    NetworkException - if node does not exist in the network.
  - containsNode
```
public final boolean containsNode(Node<NODEID> node)
```
    Specified by:
    
    containsNode in interface Network<LINKID,NODEID>
    
    Parameters:
    
    node - the node to search for in the network.
    
    Returns:
    
    whether the node is in this network
  - containsNode
```
public final boolean containsNode(NODEID nodeId)
```
    Specified by:
    
    containsNode in interface Network<LINKID,NODEID>
    
    Parameters:
    
    nodeId - the id of the node to search for in the network.
    
    Returns:
    
    whether the node is in this network
  - getNode
```
public final Node<NODEID> getNode(NODEID nodeId)
```
    Specified by:
    
    getNode in interface Network<LINKID,NODEID>
    
    Parameters:
    
    nodeId - the id of the node to search for in the network.
    
    Returns:
    
    the node or null if not present
  - addLink
```
public final void addLink(Link<LINKID,NODEID> link)
                   throws NetworkException
```
    Specified by:
    
    addLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    link - the link to add to the network.
    
    Throws:
    
    NetworkException - if link already exists in the network, if name of the link is not unique, or if the start node or the end node of the link are not registered in the network.
  - removeLink
```
public final void removeLink(Link<LINKID,NODEID> link)
                      throws NetworkException
```
    Specified by:
    
    removeLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    link - the link to remove from the network.
    
    Throws:
    
    NetworkException - if link does not exist in the network.
  - getLink
```
public final Link<LINKID,NODEID> getLink(Node<NODEID> node1,
                                         Node<NODEID> node2)
```
    Find a link between node1 and node2 and return it if it exists in the network. If not, return null.
    
    Specified by:
    
    getLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    node1 - first node
    
    node2 - second node
    
    Returns:
    
    the link between node1 and node2 in the network or null if it does not exist.
  - getLink
```
public final Link<LINKID,NODEID> getLink(NODEID nodeId1,
                                         NODEID nodeId2)
                                  throws NetworkException
```
    Find a link between node1 and node2 and return it if it exists in the network. If not, return null.
    
    Specified by:
    
    getLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    nodeId1 - id of the first node
    
    nodeId2 - id of the second node
    
    Returns:
    
    the link between node1 and node2 in the network or null if it does not exist.
    
    Throws:
    
    NetworkException - if the node(s) cannot be found by their id
  - containsLink
```
public final boolean containsLink(Link<LINKID,NODEID> link)
```
    Specified by:
    
    containsLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    link - the link to search for in the network.
    
    Returns:
    
    whether the link is in this network
  - containsLink
```
public final boolean containsLink(LINKID linkId)
```
    Specified by:
    
    containsLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    linkId - the id of the link to search for in the network.
    
    Returns:
    
    whether the link is in this network
  - getLink
```
public final Link<LINKID,NODEID> getLink(LINKID linkId)
```
    Specified by:
    
    getLink in interface Network<LINKID,NODEID>
    
    Parameters:
    
    linkId - the id of the link to search for in the network.
    
    Returns:
    
    the link or null if not present
  - addRoute
```
public final void addRoute(Route<LINKID,NODEID> route)
                    throws NetworkException
```
    Specified by:
    
    addRoute in interface Network<LINKID,NODEID>
    
    Parameters:
    
    route - the route to add to the network.
    
    Throws:
    
    NetworkException - if route already exists in the network, if name of the route is not unique, if one of the nodes of the route are not registered in the network.
  - removeRoute
```
public final void removeRoute(Route<LINKID,NODEID> route)
                       throws NetworkException
```
    Specified by:
    
    removeRoute in interface Network<LINKID,NODEID>
    
    Parameters:
    
    route - the route to remove from the network.
    
    Throws:
    
    NetworkException - if route does not exist in the network.
  - containsRoute
```
public final boolean containsRoute(Route<LINKID,NODEID> route)
```
    Specified by:
    
    containsRoute in interface Network<LINKID,NODEID>
    
    Parameters:
    
    route - the route to search for in the network.
    
    Returns:
    
    whether the route is in this network
  - containsRoute
```
public final boolean containsRoute(String routeId)
```
    Specified by:
    
    containsRoute in interface Network<LINKID,NODEID>
    
    Parameters:
    
    routeId - the route to search for in the network.
    
    Returns:
    
    whether the route is in this network
  - getRoute
```
public final Route<LINKID,NODEID> getRoute(String routeId)
```
    Specified by:
    
    getRoute in interface Network<LINKID,NODEID>
    
    Parameters:
    
    routeId - the route to search for in the network.
    
    Returns:
    
    the route or null if not present
  - getRoutesBetween
```
public final Set<Route<LINKID,NODEID>> getRoutesBetween(Node<NODEID> nodeFrom,
                                                        Node<NODEID> nodeTo)
```
    Specified by:
    
    getRoutesBetween in interface Network<LINKID,NODEID>
    
    Parameters:
    
    nodeFrom - the start node.
    
    nodeTo - the end node.
    
    Returns:
    
    the routes between two nodes in the network.
  - getShortestRouteBetween
```
public final Route<LINKID,NODEID> getShortestRouteBetween(Node<NODEID> nodeFrom,
                                                          Node<NODEID> nodeTo)
```
    Specified by:
    
    getShortestRouteBetween in interface Network<LINKID,NODEID>
    
    Parameters:
    
    nodeFrom - the start node.
    
    nodeTo - the end node.
    
    Returns:
    
    the shortest route between two nodes in the network.
  - getId
```
public final NETWORKID getId()
```
    Returns:
    
    id
  - getNodeMap
```
public final Map<NODEID,Node<NODEID>> getNodeMap()
```
    Specified by:
    
    getNodeMap in interface Network<LINKID,NODEID>
    
    Returns:
    
    the nodes.
  - getLinkMap
```
public final Map<LINKID,Link<LINKID,NODEID>> getLinkMap()
```
    Specified by:
    
    getLinkMap in interface Network<LINKID,NODEID>
    
    Returns:
    
    the links.
  - getRouteMap
```
public final Map<String,Route<LINKID,NODEID>> getRouteMap()
```
    Specified by:
    
    getRouteMap in interface Network<LINKID,NODEID>
    
    Returns:
    
    the defined routes in the network.

Class OTSNetwork<NETWORKID,LINKID,NODEID>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OTSNetwork

Method Detail

addNode

removeNode

containsNode

containsNode

getNode

addLink

removeLink

getLink

getLink

containsLink

containsLink

getLink

addRoute

removeRoute

containsRoute

containsRoute

getRoute

getRoutesBetween

getShortestRouteBetween

getId

getNodeMap

getLinkMap

getRouteMap