Network (Open Traffic Sim core classes 0.02.03 API)

Type Parameters:

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

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

All Known Implementing Classes:

ExpansionNetwork, OTSNetwork
```
public interface Network<LINKID,NODEID>
```
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.
$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

Method Summary

All Methods Instance Methods Abstract 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 link)`
`boolean`	`containsNode(Node<NODEID> node)`
`boolean`	`containsNode(NODEID nodeId)`
`boolean`	`containsRoute(Route<LINKID,NODEID> route)`
`boolean`	`containsRoute(String routeId)`
`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 node1, NODEID node2)` 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)`

- Method Detail
  - getNodeMap
```
Map<NODEID,Node<NODEID>> getNodeMap()
```
    Returns:
    
    the nodes.
  - getLinkMap
```
Map<LINKID,Link<LINKID,NODEID>> getLinkMap()
```
    Returns:
    
    the links.
  - getRouteMap
```
Map<String,Route<LINKID,NODEID>> getRouteMap()
```
    Returns:
    
    the defined routes in the network.
  - getRoutesBetween
```
Set<Route<LINKID,NODEID>> getRoutesBetween(Node<NODEID> nodeFrom,
                                           Node<NODEID> nodeTo)
```
    Parameters:
    
    nodeFrom - the start node.
    
    nodeTo - the end node.
    
    Returns:
    
    the routes between two nodes in the network.
  - getShortestRouteBetween
```
Route<LINKID,NODEID> getShortestRouteBetween(Node<NODEID> nodeFrom,
                                             Node<NODEID> nodeTo)
```
    Parameters:
    
    nodeFrom - the start node.
    
    nodeTo - the end node.
    
    Returns:
    
    the shortest route between two nodes in the network.
  - addNode
```
void addNode(Node<NODEID> node)
      throws NetworkException
```
    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
```
void removeNode(Node<NODEID> node)
         throws NetworkException
```
    Parameters:
    
    node - the node to remove from the network.
    
    Throws:
    
    NetworkException - if node does not exist in the network.
  - containsNode
```
boolean containsNode(Node<NODEID> node)
```
    Parameters:
    
    node - the node to search for in the network.
    
    Returns:
    
    whether the node is in this network
  - containsNode
```
boolean containsNode(NODEID nodeId)
```
    Parameters:
    
    nodeId - the id of the node to search for in the network.
    
    Returns:
    
    whether the node is in this network
  - getNode
```
Node<NODEID> getNode(NODEID nodeId)
```
    Parameters:
    
    nodeId - the id of the node to search for in the network.
    
    Returns:
    
    the node or null if not present
  - addLink
```
void addLink(Link<LINKID,NODEID> link)
      throws NetworkException
```
    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
```
void removeLink(Link<LINKID,NODEID> link)
         throws NetworkException
```
    Parameters:
    
    link - the link to remove from the network.
    
    Throws:
    
    NetworkException - if link does not exist in the network.
  - containsLink
```
boolean containsLink(Link<LINKID,NODEID> link)
```
    Parameters:
    
    link - the link to search for in the network.
    
    Returns:
    
    whether the link is in this network
  - containsLink
```
boolean containsLink(LINKID link)
```
    Parameters:
    
    link - the id of the link to search for in the network.
    
    Returns:
    
    whether the link is in this network
  - getLink
```
Link<LINKID,NODEID> getLink(LINKID linkId)
```
    Parameters:
    
    linkId - the id of the link to search for in the network.
    
    Returns:
    
    the link or null if not present
  - getLink
```
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.
    
    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
```
Link<LINKID,NODEID> getLink(NODEID node1,
                            NODEID node2)
                     throws NetworkException
```
    Find a link between node1 and node2 and return it if it exists in the network. If not, return null.
    
    Parameters:
    
    node1 - id of the first node
    
    node2 - 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
  - addRoute
```
void addRoute(Route<LINKID,NODEID> route)
       throws NetworkException
```
    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
```
void removeRoute(Route<LINKID,NODEID> route)
          throws NetworkException
```
    Parameters:
    
    route - the route to remove from the network.
    
    Throws:
    
    NetworkException - if route does not exist in the network.
  - containsRoute
```
boolean containsRoute(Route<LINKID,NODEID> route)
```
    Parameters:
    
    route - the route to search for in the network.
    
    Returns:
    
    whether the route is in this network
  - containsRoute
```
boolean containsRoute(String routeId)
```
    Parameters:
    
    routeId - the route to search for in the network.
    
    Returns:
    
    whether the route is in this network
  - getRoute
```
Route<LINKID,NODEID> getRoute(String routeId)
```
    Parameters:
    
    routeId - the route to search for in the network.
    
    Returns:
    
    the route or null if not present

Interface Network<LINKID,NODEID>

Method Summary

Method Detail

getNodeMap

getLinkMap

getRouteMap

getRoutesBetween

getShortestRouteBetween

addNode

removeNode

containsNode

containsNode

getNode

addLink

removeLink

containsLink

containsLink

getLink

getLink

getLink

addRoute

removeRoute

containsRoute

containsRoute

getRoute