org.opentrafficsim.core.network

Class OTSNetwork

java.lang.Object

org.opentrafficsim.core.network.OTSNetwork

All Implemented Interfaces:

Serializable, Network

Direct Known Subclasses:

ExpansionNetwork

public class OTSNetwork
extends Object
implements Network, 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-08-23 00:48:01 +0200 (Sun, 23 Aug 2015) $, @version $Revision: 1291 $, 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(String id) Construction of an empty network.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OTSNetwork

public OTSNetwork(String id)

Construction of an empty network.

Parameters:

id - the network id.

Method Detail

addNode

public final void addNode(Node node)
                   throws NetworkException

Specified by:

addNode in interface Network

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 node)
                      throws NetworkException

Specified by:

removeNode in interface Network

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 node)

Specified by:

containsNode in interface Network

Parameters:

node - the node to search for in the network.

Returns:

whether the node is in this network

containsNode

public final boolean containsNode(String nodeId)

Specified by:

containsNode in interface Network

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 getNode(String nodeId)

Specified by:

getNode in interface Network

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 link)
                   throws NetworkException

Specified by:

addLink in interface Network

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 link)
                      throws NetworkException

Specified by:

removeLink in interface Network

Parameters:

link - the link to remove from the network.

Throws:

NetworkException - if link does not exist in the network.

getLink

public final Link getLink(Node node1,
                          Node 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

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 getLink(String nodeId1,
                          String 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

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 link)

Specified by:

containsLink in interface Network

Parameters:

link - the link to search for in the network.

Returns:

whether the link is in this network

containsLink

public final boolean containsLink(String linkId)

Specified by:

containsLink in interface Network

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 getLink(String linkId)

Specified by:

getLink in interface Network

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 route)
                    throws NetworkException

Specified by:

addRoute in interface Network

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 route)
                       throws NetworkException

Specified by:

removeRoute in interface Network

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 route)

Specified by:

containsRoute in interface Network

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

Parameters:

routeId - the route to search for in the network.

Returns:

whether the route is in this network

getRoute

public final Route getRoute(String routeId)

Specified by:

getRoute in interface Network

Parameters:

routeId - the route to search for in the network.

Returns:

the route or null if not present

getRoutesBetween

public final Set<Route> getRoutesBetween(Node nodeFrom,
                                         Node nodeTo)

Specified by:

getRoutesBetween in interface Network

Parameters:

nodeFrom - the start node.

nodeTo - the end node.

Returns:

the routes between two nodes in the network.

getShortestRouteBetween

public final Route getShortestRouteBetween(Node nodeFrom,
                                           Node nodeTo)

Specified by:

getShortestRouteBetween in interface Network

Parameters:

nodeFrom - the start node.

nodeTo - the end node.

Returns:

the shortest route between two nodes in the network.

getId

public final String getId()

Returns:

id

getNodeMap

public final Map<String,Node> getNodeMap()

Specified by:

getNodeMap in interface Network

Returns:

the nodes.

getLinkMap

public final Map<String,Link> getLinkMap()

Specified by:

getLinkMap in interface Network

Returns:

the links.

getRouteMap

public final Map<String,Route> getRouteMap()

Specified by:

getRouteMap in interface Network

Returns:

the defined routes in the network.