Package org.matsim.core.router.util

Class AbstractRoutingNetwork

java.lang.Object

org.matsim.core.router.util.AbstractRoutingNetwork

All Implemented Interfaces:

Network, MatsimToplevelContainer, RoutingNetwork, Attributable

Direct Known Subclasses:

ArrayRoutingNetwork

public abstract class AbstractRoutingNetwork
extends Object
implements RoutingNetwork

Constructor Summary

Constructors

Constructor	Description
AbstractRoutingNetwork(Network network)

Method Summary

Modifier and Type	Method	Description
void	addLink(Link ll)
void	addNode(Node nn)
void	addNode(RoutingNetworkNode nn)
Attributes	getAttributes()
double	getCapacityPeriod()	Returns the time period over which the capacity of the given links has been measured.
double	getEffectiveCellSize()
double	getEffectiveLaneWidth()	Returns the lane width of the network's links.
NetworkFactory	getFactory()	Returns the builder for network elements
Map<Id<Link>,? extends Link>	getLinks()	Returns a set of this network's links.
Map<Id<Node>,RoutingNetworkNode>	getNodes()	Returns a set of this network's nodes.
void	initialize()
Link	removeLink(Id<Link> linkId)	Removes the link with the specified Id from the network and removes it as in- or out-Links of its to- and from-Node, but does not remove any node this link is connected to.
RoutingNetworkNode	removeNode(Id<Node> nodeId)	Removes the node with the specified Id from the network, along with all links connected to that node.
void	setCapacityPeriod(double capPeriod)
void	setEffectiveCellSize(double effectiveCellSize)
void	setEffectiveLaneWidth(double effectiveLaneWidth)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.matsim.api.core.v01.network.Network

getName, setName

Constructor Detail

AbstractRoutingNetwork

public AbstractRoutingNetwork(Network network)

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface RoutingNetwork

getFactory

public NetworkFactory getFactory()

Description copied from interface: Network

Returns the builder for network elements

Specified by:

getFactory in interface MatsimToplevelContainer

Specified by:

getFactory in interface Network

getNodes

public Map<Id<Node>,RoutingNetworkNode> getNodes()

Description copied from interface: Network

Returns a set of this network's nodes. This set might be empty, but it should not be null.

Specified by:

getNodes in interface Network

Specified by:

getNodes in interface RoutingNetwork

Returns:

a set of this network's nodes

addNode

public void addNode(RoutingNetworkNode nn)

removeNode

public RoutingNetworkNode removeNode(Id<Node> nodeId)

Description copied from interface: Network

Removes the node with the specified Id from the network, along with all links connected to that node. The return value corresponds to the behavior of Map.remove(Object)

Specified by:

removeNode in interface Network

Parameters:

nodeId - node to be removed

Returns:

the removed node, or null if no such node was found

addLink

public void addLink(Link ll)

Specified by:

addLink in interface Network

addNode

public void addNode(Node nn)

Specified by:

addNode in interface Network

getCapacityPeriod

public double getCapacityPeriod()

Description copied from interface: Network

Returns the time period over which the capacity of the given links has been measured. The default is given in the dtd. Currently (may'11) it is 1h = 3600.0 sec.

Notes:

• There is no setter for this value since API-based network generation code should not use anything else but the default. The default is in the network dtd, but it is an attribute under "links", not under "network".

Specified by:

getCapacityPeriod in interface Network

Returns:

the time period in seconds

getEffectiveLaneWidth

public double getEffectiveLaneWidth()

Description copied from interface: Network

Returns the lane width of the network's links. The default is given in the dtd; current (may'11) it is 3.75m.

Notes:

• There is no setter for this value since API-based network generation code should not use anything else but the default.

Specified by:

getEffectiveLaneWidth in interface Network

Returns:

the lane width in meters

getLinks

public Map<Id<Link>,? extends Link> getLinks()

Description copied from interface: Network

Returns a set of this network's links. This set might be empty, but it should not be null.

Specified by:

getLinks in interface Network

Returns:

a set of this network's links

removeLink

public Link removeLink(Id<Link> linkId)

Description copied from interface: Network

Removes the link with the specified Id from the network and removes it as in- or out-Links of its to- and from-Node, but does not remove any node this link is connected to. The return value corresponds to the behavior of Map.remove(Object)

Specified by:

removeLink in interface Network

Parameters:

linkId - node to be removed

Returns:

the removed link, or null if no such link was found

setCapacityPeriod

public void setCapacityPeriod(double capPeriod)

Specified by:

setCapacityPeriod in interface Network

setEffectiveCellSize

public void setEffectiveCellSize(double effectiveCellSize)

Specified by:

setEffectiveCellSize in interface Network

setEffectiveLaneWidth

public void setEffectiveLaneWidth(double effectiveLaneWidth)

Specified by:

setEffectiveLaneWidth in interface Network

getEffectiveCellSize

public double getEffectiveCellSize()

Specified by:

getEffectiveCellSize in interface Network

getAttributes

public Attributes getAttributes()

Specified by:

getAttributes in interface Attributable