org.opentrafficsim.core.network

Class ExpansionNetwork<ID,L extends Link<?,?>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<L>

org.opentrafficsim.core.network.Network<ID,L>

org.opentrafficsim.core.network.ExpansionNetwork<ID,L>

Type Parameters:

ID - the ID type of the network.

L -

All Implemented Interfaces:

Serializable, Cloneable, Iterable<L>, Collection<L>, Set<L>

public class ExpansionNetwork<ID,L extends Link<?,?>>
extends Network<ID,L>

A Network consists of a set of links. Each link has, in its turn, a start node and an end node. An expandable network can be an (expanded) node as well. An example is shown below:

            |
     -------O--------
            |
 

can be expanded into:

            |
            A
           /|\
          / | \
    -----B--C--D-----
          \ | /
           \|/
            E
            |
 

Node O in the example is expanded into the subnetwork consisting of nodes A, B, C, D, and E, and links AB, AC, AD, BC, CD, BE, CE, and DE. It also means that when node expansion takes place, the links to node O have to be replaced. In the example below:

            X
            |
     Y------O-------Z
            |
            W
 

can be expanded into:

            X
            |
            A
           /|\
          / | \
    Y----B--C--D----Z
          \ | /
           \|/
            E
            |
            W
 

the node XO is replaced by XA, YO is replaced by YB, OZ is replaced by DZ, and OW is replaced by EW in the network. The reverse takes place when we do node collapse.

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.

Version:

Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExpansionNetwork(ID id) Construction of an empty network.
ExpansionNetwork(ID id, Collection<? extends L> collection) Construction of a network with an initial set of links.
ExpansionNetwork(ID id, Collection<? extends L> collection, Node<?,?> expansionNode) Construction of a network with an initial set of links, and an expansion node.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	collapseLinks(Node<?,?> node1, Node<?,?> node2) Collapse all links between two given nodes into one forward and one reverse link.
boolean	collapseToNode(HashSet<Node<?,?>> nodesOfSubNetwork) Collapse a nodes into a sub network.
boolean	deleteNode(Node<?,?> deleteThis) Delete a node from this network (or a sub-network of this network).
Set<L>	findLinkHierarchyBelow(int hierarchyLevel) Find all links that have a hierarchy level not exceeding the specified value.
Node<?,?>	getExpansionOfNode()
ExpansionNetwork<?,?>	getSubNetworkConsistNode(Node<?,?> node) Return the sub network that directly owns a specified node.
boolean	isInNetwork(Node<?,?> node, boolean recurse) Determine if a node is part of this Network.
void	setExpansionOfNode(Node<?,?> expansionOfNode)

Methods inherited from class org.opentrafficsim.core.network.Network

addNode, getId, getNodeSet, isInNetwork, setNodeSet

Methods inherited from class java.util.HashSet

add, clear, clone, contains, isEmpty, iterator, remove, size

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Constructor Detail

ExpansionNetwork

public ExpansionNetwork(ID id)

Construction of an empty network.

Parameters:

id - the network id.

ExpansionNetwork

public ExpansionNetwork(ID id,
                Collection<? extends L> collection)

Construction of a network with an initial set of links.

Parameters:

id - the network id.

collection - the initial collection of links.

ExpansionNetwork

public ExpansionNetwork(ID id,
                Collection<? extends L> collection,
                Node<?,?> expansionNode)
                 throws NetworkException

Construction of a network with an initial set of links, and an expansion node.

Parameters:

id - the network id.

collection - the initial collection of links.

expansionNode - Node of which this network is an expansion.

Throws:

NetworkException - when expansion node is part of the initial collection.

Method Detail

getExpansionOfNode

public final Node<?,?> getExpansionOfNode()

Returns:

expansionOfNode

setExpansionOfNode

public final void setExpansionOfNode(Node<?,?> expansionOfNode)
                              throws NetworkException

Parameters:

expansionOfNode - set expansionOfNode

Throws:

NetworkException - when expansion node is part of the node collection.

isInNetwork

public final boolean isInNetwork(Node<?,?> node,
                  boolean recurse)

Determine if a node is part of this Network.

Parameters:

node - Node<?, ?>; the node

recurse - boolean; if true also search sub-networks

Returns:

true or false

getSubNetworkConsistNode

public final ExpansionNetwork<?,?> getSubNetworkConsistNode(Node<?,?> node)
                                                     throws NetworkException

Return the sub network that directly owns a specified node.

Parameters:

node - Node<?, ?>; the node

Returns:

Network

Throws:

NetworkException - if the specified node is not contained in this Network or any of its sub Networks

deleteNode

public final boolean deleteNode(Node<?,?> deleteThis)
                         throws NetworkException

Delete a node from this network (or a sub-network of this network).

Overrides:

deleteNode in class Network<ID,L extends Link<?,?>>

Parameters:

deleteThis - Node<?, ?>; the node that must be deleted

Returns:

boolean

Throws:

NetworkException - on network inconsistency

collapseToNode

public final boolean collapseToNode(HashSet<Node<?,?>> nodesOfSubNetwork)

Collapse a nodes into a sub network.

Parameters:

nodesOfSubNetwork - HashSet<Node<?, ?>>; the nodes that go into the new sub network

Returns:

boolean; Currently always true (because some checks have not been implemented...)

collapseLinks

public final boolean collapseLinks(Node<?,?> node1,
                    Node<?,?> node2)

Collapse all links between two given nodes into one forward and one reverse link.

Parameters:

node1 - Node; the first node

node2 - Node; the second node

Returns:

true if successful, false there are no links between the nodes

findLinkHierarchyBelow

public final Set<L> findLinkHierarchyBelow(int hierarchyLevel)
                                                      throws NetworkException

Find all links that have a hierarchy level not exceeding the specified value.
Highest hierarchy value is 0; 1 is next lower level, etc.

Parameters:

hierarchyLevel - int; the maximum hierarchy level of the returned links

Returns:

Set<L>

Throws:

NetworkException - on network inconsistency