org.opentrafficsim.core.gtu

Class GTUType

java.lang.Object

org.opentrafficsim.base.Type<T>

org.opentrafficsim.base.HierarchicalType<GTUType>

org.opentrafficsim.core.gtu.GTUType

All Implemented Interfaces:

Serializable, Identifiable

public final class GTUType
extends HierarchicalType<GTUType>
implements Serializable

A GTU type identifies the type of a GTU.
GTU types are used to check whether a particular GTU can travel over a particular part of infrastructure. E.g. a (LaneBased)GTU with GTUType CAR can travel over lanes that have a LaneType that has the GTUType CAR in the compatibility set.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 4831 $, $LastChangedDate: 2019-01-06 01:35:05 +0100 (Sun, 06 Jan 2019) $, by $Author: averbraeck $, initial version Dec 31, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static GTUType	BICYCLE Super type for bicycle.
static GTUType	BUS Super type for busses.
static GTUType	CAR Super type for cars.
static GTUType	EMERGENCY_VEHICLE Super type for emergency vehicles.
static GTUType	MOPED Super type for mopeds.
static GTUType	PEDESTRIAN Super type for pedestrians.
static GTUType	RAIL_WAY_USER Super type for all rail users.
static GTUType	ROAD_USER Super type for all road users.
static GTUType	SCHEDULED_BUS Super type for scheduled busses.
static GTUType	SHIP Super type for ships.
static GTUType	TRAIN Super type for trains.
static GTUType	TRUCK Super type for trucks.
static GTUType	VAN Super type for vans.
static GTUType	VEHICLE Super type for vehicles.
static GTUType	WATER_WAY_USER Super type for all water way users.

Constructor Summary

Constructors

Constructor and Description
GTUType(String id, GTUType parent)

Method Summary

Modifier and Type	Method and Description
static GTUCharacteristics	defaultCharacteristics(GTUType gtuType, StreamInterface randomStream) Returns default characteristics for given GTUType.
String	toString()

Methods inherited from class org.opentrafficsim.base.HierarchicalType

commonAncestor, equals, getId, getParent, hashCode, 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

ROAD_USER

public static final GTUType ROAD_USER

Super type for all road users.

WATER_WAY_USER

public static final GTUType WATER_WAY_USER

Super type for all water way users.

RAIL_WAY_USER

public static final GTUType RAIL_WAY_USER

Super type for all rail users.

PEDESTRIAN

public static final GTUType PEDESTRIAN

Super type for pedestrians.

BICYCLE

public static final GTUType BICYCLE

Super type for bicycle.

MOPED

public static final GTUType MOPED

Super type for mopeds.

VEHICLE

public static final GTUType VEHICLE

Super type for vehicles.

EMERGENCY_VEHICLE

public static final GTUType EMERGENCY_VEHICLE

Super type for emergency vehicles.

SHIP

public static final GTUType SHIP

Super type for ships.

TRAIN

public static final GTUType TRAIN

Super type for trains.

CAR

public static final GTUType CAR

Super type for cars.

VAN

public static final GTUType VAN

Super type for vans.

BUS

public static final GTUType BUS

Super type for busses.

TRUCK

public static final GTUType TRUCK

Super type for trucks.

SCHEDULED_BUS

public static final GTUType SCHEDULED_BUS

Super type for scheduled busses.

Constructor Detail

GTUType

public GTUType(String id,
               GTUType parent)
        throws NullPointerException

Parameters:

id - String; The id of the GTUType to make it identifiable.

parent - GTUType; parent GTU type

Throws:

NullPointerException - if the id is null

Method Detail

defaultCharacteristics

public static GTUCharacteristics defaultCharacteristics(GTUType gtuType,
                                                        StreamInterface randomStream)
                                                 throws GTUException

Returns default characteristics for given GTUType.

Parameters:

gtuType - GTUType; GTUType GTU type

randomStream - StreamInterface; stream for random numbers

Returns:

default characteristics for given GTUType

Throws:

GTUException - if there are no default characteristics for the GTU type

toString

public String toString()

Overrides:

toString in class Object