org.opentrafficsim.core.network

Class OTSLink

java.lang.Object

org.opentrafficsim.core.network.OTSLink

All Implemented Interfaces:

Serializable, LocatableInterface, Link

Direct Known Subclasses:

CapacityOTSLink

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-11-11 13:25:26 +0100 (Wed, 11 Nov 2015) $, @version $Revision: 1548 $, 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, LongitudinalDirectionality directionality) Construct a new link, with a directionality for all GTUs as provided.
OTSLink(String id, OTSNode startNode, OTSNode endNode, LinkType linkType, OTSLine3D designLine, Map<GTUType,LongitudinalDirectionality> directionalityMap) Construct a new link.

Method Summary

Modifier and Type	Method and Description
void	addDirectionality(GTUType gtuType, LongitudinalDirectionality directionality) This method sets the directionality of the link for a GTU type.
boolean	equals(Object obj)
Bounds	getBounds()
OTSLine3D	getDesignLine()
LongitudinalDirectionality	getDirectionality(GTUType gtuType) This method returns the directionality of the link for a GTU type.
OTSNode	getEndNode()
String	getId()
org.djunits.value.vdouble.scalar.Length.Rel	getLength()
LinkType	getLinkType()
DirectedPoint	getLocation()
OTSNode	getStartNode()
int	hashCode()
void	removeDirectionality(GTUType gtuType) This method removes an earlier provided directionality of the link for a given GTU type, e.g.
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,
               Map<GTUType,LongitudinalDirectionality> directionalityMap)

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

directionalityMap - the directions (FORWARD, BACKWARD, BOTH, NONE) that GTUtypes can traverse this link

OTSLink

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

Construct a new link, with a directionality for all GTUs as provided.

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

directionality - the directionality for all GTUs

Method Detail

getDirectionality

public final LongitudinalDirectionality getDirectionality(GTUType gtuType)

This method returns the directionality of the link for a GTU type. It might be that the link is FORWARD (from start node to end node) for the GTU type CAR, but BOTH for the GTU type BICYCLE (i.e., bicycles can also go from end node to start node). If there is no entry for the given GTU Type, the values of GTUType.ALL will be returned. If this entry is not present, LongitudinalDirectionality.NONE will be returned.

Specified by:

getDirectionality in interface Link

Parameters:

gtuType - the GTU type to request the directionality for

Returns:

the longitudinal directionality of the link (FORWARD, BACKWARD, BOTH or NONE) for the given GTU type. NONE will be returned if no directionality is given.

addDirectionality

public final void addDirectionality(GTUType gtuType,
                                    LongitudinalDirectionality directionality)

This method sets the directionality of the link for a GTU type. It might be that the link is FORWARD (from start node to end node) for the GTU type CAR, but BOTH for the GTU type BICYCLE (i.e., bicycles can also go from end node to start node). If the directionality for a GTUType is set to NONE, this means that the given GTUTYpe cannot use the Link. If a Directionality is set for GTUType.ALL, the getDirectionality will default to these settings when there is no specific entry for a given directionality. This means that the settings can be used additive, or restrictive.
In additive use, set the directionality for GTUType.ALL to NONE, or do not set the directionality for GTUType.ALL. Now, one by one, the allowed directionalities can be added. An example is a highway, which we only open for CAR, TRUCK and BUS.
In restrictive use, set the directionality for GTUType.ALL to BOTH, FORWARD, or BACKWARD. Override the directionality for certain GTUTypes to a more restrictive access, e.g. to NONE. An example is a road that is open for all road users, except PEDESTRIAN.

Specified by:

addDirectionality in interface Link

Parameters:

gtuType - the GTU type to set the directionality for.

directionality - the longitudinal directionality of the link (FORWARD, BACKWARD, BOTH or NONE) for the given GTU type.

removeDirectionality

public final void removeDirectionality(GTUType gtuType)

This method removes an earlier provided directionality of the link for a given GTU type, e.g. for maintenance of the link. After removing, the directionality for the GTU will fall back to the provided directionality for GTUType.ALL (if present). Thereby removing a directionality is different from setting the directionality to NONE.

Specified by:

removeDirectionality in interface Link

Parameters:

gtuType - the GTU type to remove the directionality for.

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.

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