Link (Open Traffic Sim core classes 0.12.01 API)

All Superinterfaces:

Locatable, Serializable

All Known Implementing Classes:

CapacityOTSLink, OTSLink
```
public interface Link
extends Locatable, Serializable
```
Link as a connection between two Nodes.
Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2016-09-17 13:24:58 +0200 (Sat, 17 Sep 2016) $, @version $Revision: 2262 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

Fields
Modifier and Type	Field and Description
`static nl.tudelft.simulation.event.EventType`	`GTU_ADD_EVENT` The timed event type for pub/sub indicating the addition of a GTU to the link.
`static nl.tudelft.simulation.event.EventType`	`GTU_REMOVE_EVENT` The timed event type for pub/sub indicating the removal of a GTU from the link.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addDirectionality(GTUType gtuType, LongitudinalDirectionality directionality)` This method sets the directionality of the link for a GTU type.
`void`	`addGTU(GTU gtu)` Add a GTU to this link (e.g., for statistical purposes, or for a model on macro level).
`OTSLine3D`	`getDesignLine()`
`LongitudinalDirectionality`	`getDirectionality(GTUType gtuType)` This method returns the directionality of the link for a GTU type.
`Node`	`getEndNode()`
`int`	`getGTUCount()` Provide the number of GTUs on this link.
`Set<GTU>`	`getGTUs()` Provide a safe copy of the set of GTUs.
`String`	`getId()`
`org.djunits.value.vdouble.scalar.Length`	`getLength()`
`LinkType`	`getLinkType()`
`Network`	`getNetwork()` Return the network in which this link is registered.
`Node`	`getStartNode()`
`void`	`removeDirectionality(GTUType gtuType)` This method removes an earlier provided directionality of the link for a given GTU type, e.g.
`void`	`removeGTU(GTU gtu)` Remove a GTU from this link.

Methods inherited from interface nl.tudelft.simulation.dsol.animation.Locatable
getBounds, getLocation

- Field Detail
  - GTU_ADD_EVENT
```
static final nl.tudelft.simulation.event.EventType GTU_ADD_EVENT
```
    The timed event type for pub/sub indicating the addition of a GTU to the link.
    Payload: Object[] {String gtuId, GTU gtu, int count_after_addition}
  - GTU_REMOVE_EVENT
```
static final nl.tudelft.simulation.event.EventType GTU_REMOVE_EVENT
```
    The timed event type for pub/sub indicating the removal of a GTU from the link.
    Payload: Object[] {String gtuId, GTU gtu, int count_after_removal}
- Method Detail
  - getNetwork
```
Network getNetwork()
```
    Return the network in which this link is registered. Cannot be null.
    
    Returns:
    
    Network; the network in which this link is registered
  - 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 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.
  - addGTU
```
void addGTU(GTU gtu)
```
    Add a GTU to this link (e.g., for statistical purposes, or for a model on macro level). It is safe to add a GTU again. No warning or error will be given. The GTU_ADD_EVENT will only be fired when the GTU was not already on the link.
    
    Parameters:
    
    gtu - GTU; the GTU to add.
  - removeGTU
```
void removeGTU(GTU gtu)
```
    Remove a GTU from this link. It is safe to try to remove a GTU again. No warning or error will be given. The GTU_REMOVE_EVENT will only be fired when the GTU was on the link.
    
    Parameters:
    
    gtu - GTU; the GTU to remove.
  - getGTUs
```
Set<GTU> getGTUs()
```
    Provide a safe copy of the set of GTUs.
    
    Returns:
    
    Set<GTU>; a safe copy of the set of GTUs
  - getGTUCount
```
int getGTUCount()
```
    Provide the number of GTUs on this link.
    
    Returns:
    
    int; the number of GTUs on this link

Interface Link

Field Summary

Method Summary

Methods inherited from interface nl.tudelft.simulation.dsol.animation.Locatable

Field Detail

GTU_ADD_EVENT

GTU_REMOVE_EVENT

Method Detail

getNetwork

getId

getStartNode

getEndNode

getLinkType

getDesignLine

getLength

getDirectionality

addDirectionality

removeDirectionality

addGTU

removeGTU

getGTUs

getGTUCount