org.opentrafficsim.core.network

Class OTSNetwork

java.lang.Object

org.opentrafficsim.core.network.OTSNetwork

All Implemented Interfaces:

Serializable, Network, PerceivableContext

Direct Known Subclasses:

ExpansionNetwork

public class OTSNetwork
extends Object
implements Network, PerceivableContext, 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: 2016-01-25 07:46:00 +0100 (Mon, 25 Jan 2016) $, @version $Revision: 1708 $, 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	addGTU(GTU gtu) Add a GTU to the network.
void	addLink(Link link) Register a link in the network.
void	addNode(Node node) Register a node in the network.
void	addRoute(GTUType gtuType, Route route) Add a route to the network.
void	buildGraph(GTUType gtuType) (Re)build the underlying graph for the given GTUType.
boolean	containsGTU(GTU gtu) Test whether a GTU is registered in the network.
boolean	containsLink(Link link) Test whether a link is present in the network.
boolean	containsLink(String linkId) Test whether a link with a given id is present in the network.
boolean	containsNode(Node node) Test whether a node is present in the network.
boolean	containsNode(String nodeId) Test whether a node with a given id is present in the network.
boolean	containsRoute(GTUType gtuType, Route route) Determine whether the provided route exists in the network for the given GTUType.
boolean	containsRoute(GTUType gtuType, String routeId) Determine whether a route with the given id exists in the network for the given GTUType.
Map<String,Route>	getDefinedRouteMap(GTUType gtuType) Return a defensive copy of the defined routes that exist in the network for the GTUType.
Set<GTU>	getGTUs() Get an overview of the GTUs in the model.
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) Retrieve a node with a given id from the network, or null if the id cannot be found.
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() Provide a defensive copy of the map of link ids to links in the network.
Node	getNode(String nodeId) Retrieve a node with a given id from the network, or null if the id cannot be found.
Map<String,Node>	getNodeMap() Provide a defensive copy of the map of node ids to nodes in the network.
Route	getRoute(GTUType gtuType, String routeId) Return the route with the given id in the network for the given GTUType, or null if it the route with the id does not exist.
Set<Route>	getRoutesBetween(GTUType gtuType, Node nodeFrom, Node nodeTo) Return the the shortest route between two nodes in the network, via a list of intermediate nodes.
CompleteRoute	getShortestRouteBetween(GTUType gtuType, Node nodeFrom, Node nodeTo) Calculate the shortest route between two nodes in the network.
CompleteRoute	getShortestRouteBetween(GTUType gtuType, Node nodeFrom, Node nodeTo, List<Node> nodesVia) Calculate the shortest route between two nodes in the network, via a list of intermediate nodes.
void	removeGTU(GTU gtu) Remove a GTU from the network.
void	removeLink(Link link) Unregister a link from the network.
void	removeNode(Node node) Unregister a node from the network.
void	removeRoute(GTUType gtuType, Route route) Remove the route from the network, e.g.

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

getId

public final String getId()

Returns:

id

getNodeMap

public final Map<String,Node> getNodeMap()

Provide a defensive copy of the map of node ids to nodes in the network.

Specified by:

getNodeMap in interface Network

Returns:

a defensive copy of the map of nodes.

addNode

public final void addNode(Node node)
                   throws NetworkException

Register a node in the network.

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

Unregister a node from the network.

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)

Test whether a node is present in the network.

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)

Test whether a node with a given id is present in the network.

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)

Retrieve a node with a given id from the network, or null if the id cannot be found.

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

getLinkMap

public final Map<String,Link> getLinkMap()

Provide a defensive copy of the map of link ids to links in the network.

Specified by:

getLinkMap in interface Network

Returns:

the a defensive copy of the map of links.

addLink

public final void addLink(Link link)
                   throws NetworkException

Register a link in the network.

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

Unregister a link from the network.

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)

Test whether a link is present in the network.

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)

Test whether a link with a given id is present in the network.

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)

Retrieve a node with a given id from the network, or null if the id cannot be found.

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

getDefinedRouteMap

public final Map<String,Route> getDefinedRouteMap(GTUType gtuType)

Return a defensive copy of the defined routes that exist in the network for the GTUType.

Specified by:

getDefinedRouteMap in interface Network

Parameters:

gtuType - the GTUType for which to retrieve the defined routes

Returns:

a defensive copy of the defined routes in the network for the given GTUType, or an empty Map if no routes are defined for the given GTUType.

addRoute

public final void addRoute(GTUType gtuType,
                           Route route)
                    throws NetworkException

Add a route to the network.

Specified by:

addRoute in interface Network

Parameters:

gtuType - the GTUType for which to add a route

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(GTUType gtuType,
                              Route route)
                       throws NetworkException

Remove the route from the network, e.g. because of road maintenance.

Specified by:

removeRoute in interface Network

Parameters:

gtuType - the GTUType for which to remove a route

route - the route to remove from the network.

Throws:

NetworkException - if route does not exist in the network.

containsRoute

public final boolean containsRoute(GTUType gtuType,
                                   Route route)

Determine whether the provided route exists in the network for the given GTUType.

Specified by:

containsRoute in interface Network

Parameters:

gtuType - the GTUType for which to check whether the route exists

route - the route to check for

Returns:

whether the route exists in the network for the given GTUType

containsRoute

public final boolean containsRoute(GTUType gtuType,
                                   String routeId)

Determine whether a route with the given id exists in the network for the given GTUType.

Specified by:

containsRoute in interface Network

Parameters:

gtuType - the GTUType for which to check whether the route exists

routeId - the id of the route to check for

Returns:

whether a route with the given id exists in the network for the given GTUType

getRoute

public final Route getRoute(GTUType gtuType,
                            String routeId)

Return the route with the given id in the network for the given GTUType, or null if it the route with the id does not exist.

Specified by:

getRoute in interface Network

Parameters:

gtuType - the GTUType for which to retrieve a route based on its id.

routeId - the route to search for in the network.

Returns:

the route or null if not present

getRoutesBetween

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

Return the the shortest route between two nodes in the network, via a list of intermediate nodes. If no path exists from the start node to the end node via the intermediate nodes in the network, null is returned.

Specified by:

getRoutesBetween in interface Network

Parameters:

gtuType - the GTUType for which to retrieve the defined routes

nodeFrom - the start node.

nodeTo - the end node.

Returns:

a set with routes from the start Node to the end Node in the network; if no route can be found, an empty set is returned.

buildGraph

public final void buildGraph(GTUType gtuType)

(Re)build the underlying graph for the given GTUType.

Specified by:

buildGraph in interface Network

Parameters:

gtuType - the GTUType for which to (re)build the graph

getShortestRouteBetween

public final CompleteRoute getShortestRouteBetween(GTUType gtuType,
                                                   Node nodeFrom,
                                                   Node nodeTo)
                                            throws NetworkException

Calculate the shortest route between two nodes in the network. If no path exists from the start node to the end node in the network, null is returned. This method returns a CompleteRoute, which includes all nodes to get from start to end. In case the graph for the GTUType has not yet been built, this method will call the buildGraph method.

Specified by:

getShortestRouteBetween in interface Network

Parameters:

gtuType - the GTUType for which to calculate the shortest route

nodeFrom - the start node.

nodeTo - the end node.

Returns:

the shortest route from the start Node to the end Node in the network. If no path exists from the start node to the end node in the network, null is returned.

Throws:

NetworkException - in case nodes cannot be added to the route, e.g. because they are not directly connected. This can be the case when the links in the network have changed, but the graph has not been rebuilt.

getShortestRouteBetween

public final CompleteRoute getShortestRouteBetween(GTUType gtuType,
                                                   Node nodeFrom,
                                                   Node nodeTo,
                                                   List<Node> nodesVia)
                                            throws NetworkException

Calculate the shortest route between two nodes in the network, via a list of intermediate nodes. If no path exists from the start node to the end node via the intermediate nodes in the network, null is returned. This method returns a CompleteRoute, which includes all nodes to get from start to end. In case the graph for the GTUType has not yet been built, this method will call the buildGraph method.

Specified by:

getShortestRouteBetween in interface Network

Parameters:

gtuType - the GTUType for which to calculate the shortest route

nodeFrom - the start node.

nodeTo - the end node.

nodesVia - a number of nodes that the GTU has to pass between nodeFrom and nodeTo in the given order.

Returns:

the shortest route between two nodes in the network, via the intermediate nodes. If no path exists from the start node to the end node via the intermediate nodes in the network, null is returned.

Throws:

NetworkException - in case nodes cannot be added to the route, e.g. because they are not directly connected. This can be the case when the links in the network have changed, but the graph has not been rebuilt.

addGTU

public final void addGTU(GTU gtu)

Add a GTU to the network.

Specified by:

addGTU in interface PerceivableContext

Parameters:

gtu - the GTU to add

removeGTU

public final void removeGTU(GTU gtu)

Remove a GTU from the network.

Specified by:

removeGTU in interface PerceivableContext

Parameters:

gtu - the GTU to remove

containsGTU

public final boolean containsGTU(GTU gtu)

Test whether a GTU is registered in the network.

Specified by:

containsGTU in interface PerceivableContext

Parameters:

gtu - the GTU to search for

Returns:

whether the network contains this GTU

getGTUs

public final Set<GTU> getGTUs()

Get an overview of the GTUs in the model.

Specified by:

getGTUs in interface PerceivableContext

Returns:

a set of GTUs as registered in the current model.