org.opentrafficsim.core.network

Class CapacityOTSLink

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.network.OTSLink

org.opentrafficsim.core.network.CapacityOTSLink

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifiable, Capacity, Link

public class CapacityOTSLink
extends OTSLink
implements Capacity

A link with a maximum capacity, expressed as the maximum number of GTUs per time unit that the link can handle.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Nov 8, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class nl.tudelft.simulation.event.EventProducer

listeners

Fields inherited from interface org.opentrafficsim.core.network.Link

GTU_ADD_EVENT, GTU_REMOVE_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapacityOTSLink(Network newNetwork, OTSSimulatorInterface newSimulator, boolean animation, CapacityOTSLink link) Clone a link for a new network.
	CapacityOTSLink(Network network, String id, Node startNode, Node endNode, LinkType linkType, OTSLine3D designLine, OTSSimulatorInterface simulator, org.djunits.value.vdouble.scalar.Frequency capacity) Construct a new link.

Method Summary

Modifier and Type	Method and Description
CapacityOTSLink	clone(Network newNetwork, OTSSimulatorInterface newSimulator, boolean animation) Clone the OTSLink for e.g., copying a network.
org.djunits.value.vdouble.scalar.Frequency	getCapacity()
void	setCapacity(org.djunits.value.vdouble.scalar.Frequency capacity) Set the link capacity.
String	toString()

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

addGTU, equals, getBounds, getDesignLine, getDirectionality, getEndNode, getGTUCount, getGTUs, getId, getLength, getLinkType, getLocation, getNetwork, getSimulator, getStartNode, hashCode, removeGTU

Methods inherited from class nl.tudelft.simulation.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

CapacityOTSLink

public CapacityOTSLink(Network network,
                       String id,
                       Node startNode,
                       Node endNode,
                       LinkType linkType,
                       OTSLine3D designLine,
                       OTSSimulatorInterface simulator,
                       org.djunits.value.vdouble.scalar.Frequency capacity)
                throws NetworkException

Construct a new link.

Parameters:

network - the network.

id - the link id

startNode - start node (directional)

endNode - end node (directional)

linkType - Link type to indicate compatibility with GTU types

designLine - the OTSLine3D design line of the Link

simulator - the simulator on which events can be scheduled

capacity - link capacity in GTUs per hour // XXX per direction? which GTUType?

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.

CapacityOTSLink

protected CapacityOTSLink(Network newNetwork,
                          OTSSimulatorInterface newSimulator,
                          boolean animation,
                          CapacityOTSLink link)
                   throws NetworkException

Clone a link for a new network.

Parameters:

newNetwork - the new network to which the clone belongs

newSimulator - the new simulator for this network

animation - whether to (re)create animation or not

link - the link to clone from

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.

Method Detail

getCapacity

public final org.djunits.value.vdouble.scalar.Frequency getCapacity()

Specified by:

getCapacity in interface Capacity

Returns:

link capacity.

setCapacity

public final void setCapacity(org.djunits.value.vdouble.scalar.Frequency capacity)

Set the link capacity.

Specified by:

setCapacity in interface Capacity

Parameters:

capacity - the new capacity of the link as a frequency in GTUs per time unit.

toString

public final String toString()

Overrides:

toString in class OTSLink

clone

public CapacityOTSLink clone(Network newNetwork,
                             OTSSimulatorInterface newSimulator,
                             boolean animation)
                      throws NetworkException

Clone the OTSLink for e.g., copying a network.

Overrides:

clone in class OTSLink

Parameters:

newNetwork - the new network to which the clone belongs

newSimulator - the new simulator for this network

animation - whether to (re)create animation or not

Returns:

a clone of this object

Throws:

NetworkException - in case the cloning fails