OTSLink (Open Traffic Sim core classes 1.00.02 API)

java.lang.Object
- nl.tudelft.simulation.event.EventProducer
- - org.opentrafficsim.core.network.OTSLink

All Implemented Interfaces:

Serializable, Locatable, EventProducerInterface, Identifiable, Link

Direct Known Subclasses:

CapacityOTSLink
```
public class OTSLink
extends EventProducer
implements Link, Serializable, Locatable
```
A standard implementation of a link between two OTSNodes.
Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, @version $Revision: 4006 $, by $Author: averbraeck $, initial version Aug 19, 2014

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`	`OTSLink(Network newNetwork, SimulatorInterface.TimeDoubleUnit newSimulator, boolean animation, OTSLink link)` Clone a link for a new network.
	`OTSLink(Network network, String id, Node startNode, Node endNode, LinkType linkType, OTSLine3D designLine, SimulatorInterface.TimeDoubleUnit simulator)` Construct a new link.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGTU(GTU gtu)` Add a GTU to this link (e.g., for statistical purposes, or for a model on macro level).
`OTSLink`	`clone(Network newNetwork, SimulatorInterface.TimeDoubleUnit newSimulator, boolean animation)` Clone the OTSLink for e.g., copying a network.
`boolean`	`equals(Object obj)`
`javax.media.j3d.Bounds`	`getBounds()`
`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()`
`Length`	`getLength()`
`LinkType`	`getLinkType()`
`DirectedPoint`	`getLocation()`
`Network`	`getNetwork()` Return the network in which this link is registered.
`SimulatorInterface.TimeDoubleUnit`	`getSimulator()`
`Node`	`getStartNode()`
`int`	`hashCode()`
`void`	`removeGTU(GTU gtu)` Remove a GTU from this link.
`String`	`toString()`

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
  - OTSLink
```
public OTSLink(Network network,
               String id,
               Node startNode,
               Node endNode,
               LinkType linkType,
               OTSLine3D designLine,
               SimulatorInterface.TimeDoubleUnit simulator)
        throws NetworkException
```
    Construct a new link.
    
    Parameters:
    
    id - the link id
    
    network - the network to which the link belongs
    
    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
    
    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.
  - OTSLink
```
protected OTSLink(Network newNetwork,
                  SimulatorInterface.TimeDoubleUnit newSimulator,
                  boolean animation,
                  OTSLink 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. Could be used in subclasses.
    
    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
  - 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.
  - addGTU
```
public final 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.
    
    Specified by:
    
    addGTU in interface Link
    
    Parameters:
    
    gtu - GTU; the GTU to add.
  - removeGTU
```
public final 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.
    
    Specified by:
    
    removeGTU in interface Link
    
    Parameters:
    
    gtu - GTU; the GTU to remove.
  - getGTUs
```
public final Set<GTU> getGTUs()
```
    Provide a safe copy of the set of GTUs.
    
    Specified by:
    
    getGTUs in interface Link
    
    Returns:
    
    Set<GTU>; a safe copy of the set of GTUs
  - getGTUCount
```
public final int getGTUCount()
```
    Provide the number of GTUs on this link.
    
    Specified by:
    
    getGTUCount in interface Link
    
    Returns:
    
    int; the number of GTUs on this link
  - getNetwork
```
public final Network getNetwork()
```
    Return the network in which this link is registered. Cannot be null.
    
    Specified by:
    
    getNetwork in interface Link
    
    Returns:
    
    Network; the network in which this link is registered
  - getId
```
public final String getId()
```
    Specified by:
    
    getId in interface Identifiable
    
    Specified by:
    
    getId in interface Link
    
    Returns:
    
    id.
  - getStartNode
```
public final Node getStartNode()
```
    Specified by:
    
    getStartNode in interface Link
    
    Returns:
    
    start node.
  - getEndNode
```
public final Node 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.
  - getSimulator
```
public final SimulatorInterface.TimeDoubleUnit getSimulator()
```
    Specified by:
    
    getSimulator in interface Link
    
    Returns:
    
    the simulator.
  - getLength
```
public final Length getLength()
```
    Specified by:
    
    getLength in interface Link
    
    Returns:
    
    length of the link.
  - getLocation
```
public DirectedPoint getLocation()
```
    Specified by:
    
    getLocation in interface Locatable
  - getBounds
```
public javax.media.j3d.Bounds getBounds()
```
    Specified by:
    
    getBounds in interface Locatable
  - 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
  - clone
```
public OTSLink clone(Network newNetwork,
                     SimulatorInterface.TimeDoubleUnit newSimulator,
                     boolean animation)
              throws NetworkException
```
    Clone the OTSLink for e.g., copying a 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
    
    Returns:
    
    a clone of this object
    
    Throws:
    
    NetworkException - in case the cloning fails

Class OTSLink

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

OTSLink

OTSLink

Method Detail

getDirectionality

addGTU

removeGTU

getGTUs

getGTUCount

getNetwork

getId

getStartNode

getEndNode

getLinkType

getDesignLine

getSimulator

getLength

getLocation

getBounds

toString

hashCode

equals

clone