org.opentrafficsim.core.network

Interface Link

All Superinterfaces:

LocatableInterface, Serializable

All Known Implementing Classes:

CapacityOTSLink, OTSLink

public interface Link
extends LocatableInterface, Serializable

Link as a connection between two Nodes.

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-08 23:04:17 +0100 (Sun, 08 Nov 2015) $, @version $Revision: 1539 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers

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.
Bounds	getBounds()
OTSLine3D	getDesignLine()
LongitudinalDirectionality	getDirectionality(GTUType gtuType) This method returns the directionality of the link for a GTU type.
Node	getEndNode()
String	getId()
org.djunits.value.vdouble.scalar.Length.Rel	getLength()
LinkType	getLinkType()
DirectedPoint	getLocation()
Node	getStartNode()
void	removeDirectionality(GTUType gtuType) This method removes an earlier provided directionality of the link for a given GTU type, e.g.

Method Detail

getId

String getId()

Returns:

id.

getStartNode

Node getStartNode()

Returns:

start node.

getEndNode

Node getEndNode()

Returns:

end node.

getLinkType

LinkType getLinkType()

Returns:

the link type.

getDesignLine

OTSLine3D getDesignLine()

Returns:

the design line.

getLength

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

Returns:

length of the link.

getDirectionality

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.

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

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.

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

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.

Parameters:

gtuType - the GTU type to remove the directionality for.

getLocation

DirectedPoint getLocation()

Specified by:

getLocation in interface LocatableInterface

getBounds

Bounds getBounds()

Specified by:

getBounds in interface LocatableInterface