LaneType (Open Traffic Sim road classes 0.16.00 API)

java.lang.Object
- org.opentrafficsim.base.Type<T>
- - org.opentrafficsim.base.HierarchicalType<LaneType>
  - - org.opentrafficsim.road.network.lane.LaneType

All Implemented Interfaces:

Serializable, org.opentrafficsim.base.Identifiable, org.opentrafficsim.core.compatibility.Compatibility<org.opentrafficsim.core.gtu.GTUType,LaneType>
```
public class LaneType
extends org.opentrafficsim.base.HierarchicalType<LaneType>
implements Serializable, org.opentrafficsim.core.compatibility.Compatibility<org.opentrafficsim.core.gtu.GTUType,LaneType>
```
Lane type to indicate compatibility with GTU types. The id of a LaneType should be unique. This is, however, not checked or enforced, as the LaneType is not a singleton as the result of the compatibilitySet. Different simulations running in the same GTU can have different compatibilitySets for LaneTypes with the same id. Therefore, uniqueness is not enforced.
Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1329 $, by $Author: averbraeck $, initial version Aug 21, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static LaneType`	`BICYCLE_PATH` Bicycle path (Dutch: fietspad).
`static LaneType`	`BUS_LANE` Bidirectional bus lane (Dutch: busstrook).
`static LaneType`	`FOOTPATH` Bidirectional footpath (Dutch: voetpad).
`static LaneType`	`FREEWAY` Controlled access roads (Dutch: snelweg).
`static LaneType`	`HIGHWAY` High speed vehicular roads (Dutch: autoweg).
`static LaneType`	`MOPED_PATH` Bidirectional bicycle lane (Dutch: (brom)fietspad).
`static LaneType`	`NONE` The lane type used for lanes that are forbidden to all GTU types.
`static LaneType`	`ONE_WAY_LANE` Vehicular lane that is two-way for PEDESTRIANS but only permitted in design direction for all other road users.
`static LaneType`	`RESIDENTIAL_ROAD_LANE` Residential vehicular roads (Dutch: woonerf).
`static LaneType`	`RURAL_ROAD_LANE` Lane on rural vehicular roads (Dutch: weg buiten bebouwde kom).
`static LaneType`	`TWO_WAY_LANE` Vehicular roads (Dutch: weg); allows all road vehicles and pedestrians.
`static LaneType`	`URBAN_ROAD_LANE` Lane on urban vehicular roads (Dutch: weg binnen bebouwde kom).

Constructor Summary

Constructors
Constructor and Description
`LaneType(String id, LaneType parent, org.opentrafficsim.core.compatibility.GTUCompatibility<LaneType> compatibility)` Create a new Lane type with a compatibility set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGtuCompatability(org.opentrafficsim.core.gtu.GTUType gtuType, org.opentrafficsim.core.network.LongitudinalDirectionality direction)` Add GTU type to compatibility.
`boolean`	`equals(Object obj)`
`org.opentrafficsim.core.network.LongitudinalDirectionality`	`getDirectionality(org.opentrafficsim.core.gtu.GTUType gtuType)` Get the permitted driving directions for a given GTU type on this Lane.
`org.opentrafficsim.core.network.LongitudinalDirectionality`	`getDirectionality(org.opentrafficsim.core.gtu.GTUType gtuType, boolean tryParentsOfGTUType)`
`int`	`hashCode()`
`LaneType`	`inv()` Construct a new Lane type based on another Lane type with longitudinally inverted compatibility.
`Boolean`	`isCompatible(org.opentrafficsim.core.gtu.GTUType gtuType, org.opentrafficsim.core.gtu.GTUDirectionality direction)` Compatibility is solely determined by a specific lane type, and independent of compatibility in super or sub types.
`String`	`toString()`

Methods inherited from class org.opentrafficsim.base.HierarchicalType
commonAncestor, getId, getParent, isOfType

Methods inherited from class org.opentrafficsim.base.Type
isType

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final LaneType NONE
```
    The lane type used for lanes that are forbidden to all GTU types.
  - TWO_WAY_LANE
```
public static final LaneType TWO_WAY_LANE
```
    Vehicular roads (Dutch: weg); allows all road vehicles and pedestrians.
  - ONE_WAY_LANE
```
public static final LaneType ONE_WAY_LANE
```
    Vehicular lane that is two-way for PEDESTRIANS but only permitted in design direction for all other road users.
  - FREEWAY
```
public static final LaneType FREEWAY
```
    Controlled access roads (Dutch: snelweg).
  - HIGHWAY
```
public static final LaneType HIGHWAY
```
    High speed vehicular roads (Dutch: autoweg).
  - RURAL_ROAD_LANE
```
public static final LaneType RURAL_ROAD_LANE
```
    Lane on rural vehicular roads (Dutch: weg buiten bebouwde kom).
  - URBAN_ROAD_LANE
```
public static final LaneType URBAN_ROAD_LANE
```
    Lane on urban vehicular roads (Dutch: weg binnen bebouwde kom).
  - RESIDENTIAL_ROAD_LANE
```
public static final LaneType RESIDENTIAL_ROAD_LANE
```
    Residential vehicular roads (Dutch: woonerf).
  - BUS_LANE
```
public static final LaneType BUS_LANE
```
    Bidirectional bus lane (Dutch: busstrook).
  - MOPED_PATH
```
public static final LaneType MOPED_PATH
```
    Bidirectional bicycle lane (Dutch: (brom)fietspad).
  - BICYCLE_PATH
```
public static final LaneType BICYCLE_PATH
```
    Bicycle path (Dutch: fietspad).
  - FOOTPATH
```
public static final LaneType FOOTPATH
```
    Bidirectional footpath (Dutch: voetpad).
- Constructor Detail
  - LaneType
```
public LaneType(String id,
                LaneType parent,
                org.opentrafficsim.core.compatibility.GTUCompatibility<LaneType> compatibility)
         throws NullPointerException
```
    Create a new Lane type with a compatibility set.
    
    Parameters:
    
    id - the id of the lane type.
    
    parent - parent type
    
    compatibility - the collection of compatible GTUTypes for this LaneType. Compatibility is solely determined by a specific lane type, and independent of compatibility in super or sub types.
    
    Throws:
    
    NullPointerException - if either the id is null, or the compatibilitySet is null
- Method Detail
  - inv
```
public final LaneType inv()
```
    Construct a new Lane type based on another Lane type with longitudinally inverted compatibility.
    
    Returns:
    
    LaneType; the new lane type
  - isCompatible
```
public final Boolean isCompatible(org.opentrafficsim.core.gtu.GTUType gtuType,
                                  org.opentrafficsim.core.gtu.GTUDirectionality direction)
```
    Compatibility is solely determined by a specific lane type, and independent of compatibility in super or sub types.
    
    Specified by:
    
    isCompatible in interface org.opentrafficsim.core.compatibility.Compatibility<org.opentrafficsim.core.gtu.GTUType,LaneType>
    
    Parameters:
    
    gtuType - GTU type to look for compatibility.
    
    direction - GTUDirectionality; the direction that the GTU is moving (with respect to the direction of the design line of the Link)
    
    Returns:
    
    boolean; true if this LaneType permits GTU type in the given direction
  - getDirectionality
```
public final org.opentrafficsim.core.network.LongitudinalDirectionality getDirectionality(org.opentrafficsim.core.gtu.GTUType gtuType)
```
    Get the permitted driving directions for a given GTU type on this Lane.
    
    Parameters:
    
    gtuType - GTUType; the GTU type
    
    Returns:
    
    LongitudinalDirectionality; the permitted directions of the GTU type on this Lane
  - addGtuCompatability
```
public final void addGtuCompatability(org.opentrafficsim.core.gtu.GTUType gtuType,
                                      org.opentrafficsim.core.network.LongitudinalDirectionality direction)
```
    Add GTU type to compatibility.
    
    Parameters:
    
    gtuType - GTUType; the GTU type to add
    
    direction - LongitudinalDirectionality; permitted direction of movement
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class org.opentrafficsim.base.HierarchicalType<LaneType>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class org.opentrafficsim.base.HierarchicalType<LaneType>
  - getDirectionality
```
public final org.opentrafficsim.core.network.LongitudinalDirectionality getDirectionality(org.opentrafficsim.core.gtu.GTUType gtuType,
                                                                                          boolean tryParentsOfGTUType)
```
    Specified by:
    
    getDirectionality in interface org.opentrafficsim.core.compatibility.Compatibility<org.opentrafficsim.core.gtu.GTUType,LaneType>

Class LaneType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.base.HierarchicalType

Methods inherited from class org.opentrafficsim.base.Type

Methods inherited from class java.lang.Object

Field Detail

NONE

TWO_WAY_LANE

ONE_WAY_LANE

FREEWAY

HIGHWAY

RURAL_ROAD_LANE

URBAN_ROAD_LANE

RESIDENTIAL_ROAD_LANE

BUS_LANE

MOPED_PATH

BICYCLE_PATH

FOOTPATH

Constructor Detail

LaneType

Method Detail

inv

isCompatible

getDirectionality

addGtuCompatability

toString

hashCode

equals

getDirectionality