org.opentrafficsim.core.network

Class OTSLink

java.lang.Object

org.opentrafficsim.core.network.OTSLink

All Implemented Interfaces:

Serializable, LocatableInterface, Link

public class OTSLink
extends Object
implements Link, Serializable, LocatableInterface

A standard implementation of a link between two OTSNodes.

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

$LastChangedDate: 2015-09-26 12:11:42 +0200 (Sat, 26 Sep 2015) $, @version $Revision: 1454 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OTSLink(String id, OTSNode startNode, OTSNode endNode, LinkType linkType, OTSLine3D designLine) Construct a new link with infinite capacity.
OTSLink(String id, OTSNode startNode, OTSNode endNode, LinkType linkType, OTSLine3D designLine, org.djunits.value.vdouble.scalar.Frequency capacity) Construct a new link.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Bounds	getBounds()
org.djunits.value.vdouble.scalar.Frequency	getCapacity()
OTSLine3D	getDesignLine()
OTSNode	getEndNode()
String	getId()
org.djunits.value.vdouble.scalar.Length.Rel	getLength()
LinkType	getLinkType()
DirectedPoint	getLocation()
OTSNode	getStartNode()
int	hashCode()
void	setCapacity(org.djunits.value.vdouble.scalar.Frequency capacity) Set the link capacity.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OTSLink

public OTSLink(String id,
               OTSNode startNode,
               OTSNode endNode,
               LinkType linkType,
               OTSLine3D designLine,
               org.djunits.value.vdouble.scalar.Frequency capacity)

Construct a new link.

Parameters:

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

capacity - link capacity in GTUs per hour

OTSLink

public OTSLink(String id,
               OTSNode startNode,
               OTSNode endNode,
               LinkType linkType,
               OTSLine3D designLine)

Construct a new link with infinite capacity.

Parameters:

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

Method Detail

getId

public final String getId()

Specified by:

getId in interface Link

Returns:

id.

getStartNode

public final OTSNode getStartNode()

Specified by:

getStartNode in interface Link

Returns:

start node.

getEndNode

public final OTSNode getEndNode()

Specified by:

getEndNode in interface Link

Returns:

end node.

getLinkType

public final LinkType getLinkType()

Specified by:

getLinkType in interface Link

Returns:

the link type.

getCapacity

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

Specified by:

getCapacity in interface Link

Returns:

link capacity.

setCapacity

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

Set the link capacity.

Specified by:

setCapacity in interface Link

Parameters:

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

getDesignLine

public final OTSLine3D getDesignLine()

Specified by:

getDesignLine in interface Link

Returns:

the design line.

getLength

public final org.djunits.value.vdouble.scalar.Length.Rel getLength()

Specified by:

getLength in interface Link

Returns:

length of the link.

getLocation

public final DirectedPoint getLocation()

Specified by:

getLocation in interface LocatableInterface

Specified by:

getLocation in interface Link

getBounds

public final Bounds getBounds()

Specified by:

getBounds in interface LocatableInterface

Specified by:

getBounds in interface Link

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object