OTSLink (Open Traffic Sim core classes 0.03.02 API)

java.lang.Object
- org.opentrafficsim.core.network.OTSLink

All Implemented Interfaces:

Serializable, LocatableInterface, org.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, Link, OTS_SCALAR

Direct Known Subclasses:

CrossSectionLink
```
public class OTSLink
extends Object
implements Link, Serializable, LocatableInterface
```
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-03 13:38:01 +0200 (Thu, 03 Sep 2015) $, @version $Revision: 1378 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR
  org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Acceleration, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AnglePlane, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSlope, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSolid, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Area, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Density, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Dimensionless, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCharge, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCurrent, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalPotential, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalResistance, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Energy, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowMass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowVolume, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Force, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Frequency, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Length, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.LinearDensity, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Mass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Power, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Pressure, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Speed, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Temperature, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Time, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Torque, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Volume

Field Summary
- Fields inherited from interface org.djunits.unit.UNITS
  ABAMPERE, ABCOULOMB, ABVOLT, ACRE, AMPERE, ARCMINUTE, ARCSECOND, ARE, ATMOSPHERE_STANDARD, ATMOSPHERE_TECHNICAL, ATOMIC_UNIT, BAR, BARYE, BTU_ISO, BTU_IT, CALORIE_IT, CENTESIMAL_ARCMINUTE, CENTESIMAL_ARCSECOND, CENTIMETER, CENTIMETER_MERCURY, COULOMB, CUBIC_CENTIMETER, CUBIC_DECIMETER, CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_SECOND, CUBIC_FOOT, CUBIC_INCH, CUBIC_INCH_PER_MINUTE, CUBIC_INCH_PER_SECOND, CUBIC_KM, CUBIC_METER, CUBIC_METER_PER_DAY, CUBIC_METER_PER_HOUR, CUBIC_METER_PER_MINUTE, CUBIC_METER_PER_SECOND, CUBIC_MILE, CUBIC_YARD, DALTON, DAY, DECIMETER, DEG, DEGREE, DEGREE_CELSIUS, DEGREE_FAHRENHEIT, DEGREE_RANKINE, DEGREE_REAUMUR, DEKAMETER, DYNE, ELECTRONVOLT, EMU, ERG, ERG_PER_SECOND, ESU, EXA_ELECTRONVOLT, FARADAY, FOOT, FOOT_MERCURY, FOOT_PER_SECOND, FOOT_PER_SECOND_2, FOOT_POUND_FORCE, FOOT_POUND_FORCE_PER_HOUR, FOOT_POUND_FORCE_PER_MINUTE, FOOT_POUND_FORCE_PER_SECOND, FRANKLIN, GAL, GALLON_IMP, GALLON_PER_DAY, GALLON_PER_HOUR, GALLON_PER_MINUTE, GALLON_PER_SECOND, GALLON_US_FLUID, GIGA_ELECTRONVOLT, GIGAHERTZ, GIGAWATT, GIGAWATT_HOUR, GRAD, GRAM, GRAM_PER_CENTIMETER_3, HECTARE, HECTOMETER, HECTOPASCAL, HERTZ, HORSEPOWER_METRIC, HOUR, INCH, INCH_MERCURY, INCH_PER_SECOND_2, INCH_POUND_FORCE, JOULE, KELVIN, KG_PER_METER_3, KGF_PER_SQUARE_MM, KILO_ELECTRONVOLT, KILOAMPERE, KILOCALORIE, KILOGRAM, KILOGRAM_FORCE, KILOGRAM_PER_SECOND, KILOHERTZ, KILOMETER, KILOOHM, KILOPASCAL, KILOVOLT, KILOWATT, KILOWATT_HOUR, KM_PER_HOUR, KM_PER_HOUR_2, KNOT, KNOT_PER_SECOND, LITER, LITER_PER_DAY, LITER_PER_HOUR, LITER_PER_MINUTE, LITER_PER_SECOND, MEGA_ELECTRONVOLT, MEGAHERTZ, MEGAOHM, MEGAVOLT, MEGAWATT, MEGAWATT_HOUR, METER, METER_KILOGRAM_FORCE, METER_PER_SECOND, METER_PER_SECOND_2, MICROAMPERE, MICROVOLT, MICROWATT_HOUR, MILE, MILE_PER_HOUR, MILE_PER_HOUR_2, MILE_PER_HOUR_PER_SECOND, MILLI_ELECTRONVOLT, MILLIAMPERE, MILLIAMPERE_HOUR, MILLIBAR, MILLIMETER, MILLIMETER_MERCURY, MILLIOHM, MILLISECOND, MILLIVOLT, MILLIWATT_HOUR, MINUTE, NANOAMPERE, NAUTICAL_MILE, NEWTON, NEWTON_METER, OHM, OUNCE, OUNCE_FORCE, OUNCE_IMP_FLUID, OUNCE_US_FLUID, PASCAL, PER_CENTIMETER, PER_DAY, PER_DECIMETER, PER_DEKAMETER, PER_FOOT, PER_HECTOMETER, PER_HOUR, PER_INCH, PER_KILOMETER, PER_METER, PER_MILE, PER_MILLIMETER, PER_MILLISECOND, PER_MINUTE, PER_NAUTICAL_MILE, PER_SECOND, PER_WEEK, PER_YARD, PETA_ELECTRONVOLT, PIEZE, PINT_IMP, PINT_US_FLUID, POUND, POUND_FOOT, POUND_FORCE, POUND_INCH, POUND_PER_SECOND, POUND_PER_SQUARE_FOOT, POUND_PER_SQUARE_INCH, QUART_IMP, QUART_US_FLUID, RAD, RADIAN, RPM, SECOND, SLOPE_ARCMINUTE, SLOPE_ARCSECOND, SLOPE_CENTESIMAL_ARCMINUTE, SLOPE_CENTESIMAL_ARCSECOND, SLOPE_DEGREE, SLOPE_GRAD, SLOPE_RADIAN, SQUARE_CENTIMETER, SQUARE_DEGREE, SQUARE_FOOT, SQUARE_INCH, SQUARE_METER, SQUARE_MILE, SQUARE_MILLIMETER, SQUARE_YARD, STANDARD_GRAVITY, STATAMPERE, STATCOULOMB, STATVOLT, STERADIAN, STHENE, STHENE_METER, STHENE_METER_PER_SECOND, TERA_ELECTRONVOLT, TERAHERTZ, TERAWATT_HOUR, TON_FORCE, TON_LONG, TON_METRIC, TON_SHORT, TONNE, TORR, VOLT, WATT, WATT_HOUR, WEEK, YARD

Constructor Summary

Constructors
Constructor and Description
`OTSLink(String id, Node startNode, Node endNode, OTSLine3D designLine)` Construct a new link with infinite capacity.
`OTSLink(String id, Node startNode, Node endNode, OTSLine3D designLine, org.djunits.value.vdouble.scalar.Frequency.Abs capacity)` Construct a new link.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Bounds`	`getBounds()`
`org.djunits.value.vdouble.scalar.Frequency.Abs`	`getCapacity()`
`OTSLine3D`	`getDesignLine()`
`Node`	`getEndNode()`
`String`	`getId()`
`org.djunits.value.vdouble.scalar.Length.Rel`	`getLength()`
`DirectedPoint`	`getLocation()`
`Node`	`getStartNode()`
`int`	`hashCode()`
`void`	`setCapacity(org.djunits.value.vdouble.scalar.Frequency.Abs 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,
               Node startNode,
               Node endNode,
               OTSLine3D designLine,
               org.djunits.value.vdouble.scalar.Frequency.Abs capacity)
```
    Construct a new link.
    
    Parameters:
    
    id - the link id
    
    startNode - start node (directional)
    
    endNode - end node (directional)
    
    designLine - the OTSLine3D design line of the Link
    
    capacity - link capacity in GTUs per hour
  - OTSLink
```
public OTSLink(String id,
               Node startNode,
               Node endNode,
               OTSLine3D designLine)
```
    Construct a new link with infinite capacity.
    
    Parameters:
    
    id - the link id
    
    startNode - start node (directional)
    
    endNode - end node (directional)
    
    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 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.
  - getCapacity
```
public final org.djunits.value.vdouble.scalar.Frequency.Abs getCapacity()
```
    Specified by:
    
    getCapacity in interface Link
    
    Returns:
    
    link capacity.
  - setCapacity
```
public final void setCapacity(org.djunits.value.vdouble.scalar.Frequency.Abs 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLocation
```
public final DirectedPoint getLocation()
                                throws RemoteException
```
    Specified by:
    
    getLocation in interface LocatableInterface
    
    Throws:
    
    RemoteException
  - getBounds
```
public final Bounds getBounds()
                       throws RemoteException
```
    Specified by:
    
    getBounds in interface LocatableInterface
    
    Throws:
    
    RemoteException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class OTSLink

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR

Field Summary

Fields inherited from interface org.djunits.unit.UNITS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OTSLink

OTSLink

Method Detail

getId

getStartNode

getEndNode

getCapacity

setCapacity

getDesignLine

getLength

toString

getLocation

getBounds

hashCode

equals