org.opentrafficsim.core.network

Class Network<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>

Type Parameters:

ID - the ID type of the network

L - the Link type of the network

All Implemented Interfaces:

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

Direct Known Subclasses:

ExpansionNetwork, SubNetwork

public class Network<ID,L extends Link<?,?>>
extends HashSet<L>
implements 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-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
Network(ID id) Construction of an empty network.
Network(ID id, Collection<? extends L> collection) Construction of a network with an initial set of links.

Method Summary

Modifier and Type	Method and Description
void	addNode(Node<?,?> node) Add a node to this Network.
boolean	deleteNode(Node<?,?> deleteThis) Delete a node from this network.
ID	getId()
Set<Node<?,?>>	getNodeSet()
boolean	isInNetwork(Node<?,?> node) Determine if a node is part of this Network.
void	setNodeSet(Set<Node<?,?>> nodeSet)

Methods inherited from class java.util.HashSet

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

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Network

public Network(ID id)

Construction of an empty network.

Parameters:

id - the network id.

Network

public Network(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.

Method Detail

getId

public final ID getId()

Returns:

id

getNodeSet

public final Set<Node<?,?>> getNodeSet()

Returns:

nodeSet

setNodeSet

public final void setNodeSet(Set<Node<?,?>> nodeSet)

Parameters:

nodeSet - set nodeSet

isInNetwork

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

Determine if a node is part of this Network.

Parameters:

node - AbstractNode<?, ?>; the node

Returns:

true or false

addNode

public final void addNode(Node<?,?> node)
                   throws NetworkException

Add a node to this Network.

Parameters:

node - Node; the node that must be added

Throws:

NetworkException - if the node is already part of this network

deleteNode

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

Delete a node from this network.

Parameters:

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

Returns:

boolean

Throws:

NetworkException - on network inconsistency Note: method can be overridden, e.g. by the ExpansionNetwork.