org.opentrafficsim.core.network

Interface Network

All Known Implementing Classes:

ExpansionNetwork, OTSNetwork

public interface Network

Interface that defines what information a network should be able to provide about Nodes, Links and Routes.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2016-09-23 13:40:04 +0200 (Fri, 23 Sep 2016) $, @version $Revision: 2274 $, by $Author: averbraeck $, initial version Jul 22, 2015

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

Field Summary

Fields

Modifier and Type	Field and Description
static EventType	GTU_ADD_EVENT The timed event type for pub/sub indicating the addition of a GTU to the network.
static EventType	GTU_REMOVE_EVENT The timed event type for pub/sub indicating the removal of a GTU from the network.
static EventType	LINK_ADD_EVENT The (regular, not timed) event type for pub/sub indicating the addition of a Link.
static EventType	LINK_REMOVE_EVENT The (regular, not timed) event type for pub/sub indicating the removal of a Link.
static EventType	NODE_ADD_EVENT The (regular, not timed) event type for pub/sub indicating the addition of a Node.
static EventType	NODE_REMOVE_EVENT The (regular, not timed) event type for pub/sub indicating the removal of a Node.
static EventType	ROUTE_ADD_EVENT The (regular, not timed) event type for pub/sub indicating the addition of a Route for a gtuType.
static EventType	ROUTE_REMOVE_EVENT The (regular, not timed) event type for pub/sub indicating the removal of a Route for a gtuType.

Method Summary

Modifier and Type	Method and Description
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	containsLink(Link link) Test whether a link is present in the network.
boolean	containsLink(String link) 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.
ImmutableMap<String,Route>	getDefinedRouteMap(GTUType gtuType) Return an immutable map of routes that exist in the network for the GTUType.
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.
ImmutableMap<String,Link>	getLinkMap() Provide an immutable 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.
ImmutableMap<String,Node>	getNodeMap() Provide an immutable 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	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.

Field Detail

NODE_ADD_EVENT

static final EventType NODE_ADD_EVENT

The (regular, not timed) event type for pub/sub indicating the addition of a Node.
Payload: String nodeId (not an array, just a String)

NODE_REMOVE_EVENT

static final EventType NODE_REMOVE_EVENT

The (regular, not timed) event type for pub/sub indicating the removal of a Node.
Payload: String nodeId (not an array, just a String)

LINK_ADD_EVENT

static final EventType LINK_ADD_EVENT

The (regular, not timed) event type for pub/sub indicating the addition of a Link.
Payload: String linkId (not an array, just a String)

LINK_REMOVE_EVENT

static final EventType LINK_REMOVE_EVENT

The (regular, not timed) event type for pub/sub indicating the removal of a Link.
Payload: String linkId (not an array, just a String)

ROUTE_ADD_EVENT

static final EventType ROUTE_ADD_EVENT

The (regular, not timed) event type for pub/sub indicating the addition of a Route for a gtuType.
Payload: [String gtuTypeId, String routeId]

ROUTE_REMOVE_EVENT

static final EventType ROUTE_REMOVE_EVENT

The (regular, not timed) event type for pub/sub indicating the removal of a Route for a gtuType.
Payload: [String gtuTypeId, String routeId]

GTU_ADD_EVENT

static final EventType GTU_ADD_EVENT

The timed event type for pub/sub indicating the addition of a GTU to the network.
Payload: String gtuId (not an array, just a String)

GTU_REMOVE_EVENT

static final EventType GTU_REMOVE_EVENT

The timed event type for pub/sub indicating the removal of a GTU from the network.
Payload: String gtuId (not an array, just a String)

Method Detail

getId

String getId()

Returns:

String; the id

getNodeMap

ImmutableMap<String,Node> getNodeMap()

Provide an immutable map of node ids to nodes in the network.

Returns:

an immutable map of nodes.

addNode

void addNode(Node node)
      throws NetworkException

Register a node in the 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

void removeNode(Node node)
         throws NetworkException

Unregister a node from the network.

Parameters:

node - the node to remove from the network.

Throws:

NetworkException - if node does not exist in the network.

containsNode

boolean containsNode(Node node)

Test whether a node is present in the network.

Parameters:

node - the node to search for in the network.

Returns:

whether the node is in this network

containsNode

boolean containsNode(String nodeId)

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

Parameters:

nodeId - the id of the node to search for in the network.

Returns:

whether the node is in this network

getNode

Node getNode(String nodeId)

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

Parameters:

nodeId - the id of the node to search for in the network.

Returns:

the node or null if not present

getLinkMap

ImmutableMap<String,Link> getLinkMap()

Provide an immutable map of link ids to links in the network.

Returns:

the an immutable map of links.

addLink

void addLink(Link link)
      throws NetworkException

Register a link in the 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

void removeLink(Link link)
         throws NetworkException

Unregister a link from the network.

Parameters:

link - the link to remove from the network.

Throws:

NetworkException - if link does not exist in the network.

containsLink

boolean containsLink(Link link)

Test whether a link is present in the network.

Parameters:

link - the link to search for in the network.

Returns:

whether the link is in this network

containsLink

boolean containsLink(String link)

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

Parameters:

link - the id of the link to search for in the network.

Returns:

whether the link is in this network

getLink

Link getLink(String linkId)

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

Parameters:

linkId - the id of the link to search for in the network.

Returns:

the link or null if not present

getLink

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.

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 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.

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

getDefinedRouteMap

ImmutableMap<String,Route> getDefinedRouteMap(GTUType gtuType)

Return an immutable map of routes that exist in the network for the GTUType.

Parameters:

gtuType - the GTUType for which to retrieve the defined routes

Returns:

an immutable map of routes in the network for the given GTUType, or an empty Map if no routes are defined for the given GTUType.

addRoute

void addRoute(GTUType gtuType,
              Route route)
       throws NetworkException

Add a route to the 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

void removeRoute(GTUType gtuType,
                 Route route)
          throws NetworkException

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

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.

getRoute

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.

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

containsRoute

boolean containsRoute(GTUType gtuType,
                      Route route)

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

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

boolean containsRoute(GTUType gtuType,
                      String routeId)

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

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

getRoutesBetween

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.

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

void buildGraph(GTUType gtuType)

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

Parameters:

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

getShortestRouteBetween

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.

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

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.

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.