org.opentrafficsim.core.gtu

Class GTUType

java.lang.Object

org.opentrafficsim.base.Type<GTUType>

org.opentrafficsim.core.gtu.GTUType

All Implemented Interfaces:

Serializable

public final class GTUType
extends org.opentrafficsim.base.Type<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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 2930 $, $LastChangedDate: 2016-12-13 02:02:22 +0100 (Tue, 13 Dec 2016) $, by $Author: wjschakel $, 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	ALL ALL GTUType to be used only for permeability and accessibility.
static GTUType	BIKE Super type for bikes.
static GTUType	BOAT Super type for boats.
static GTUType	NONE NONE GTUType to be used only for permeability and accessibility.
static GTUType	PEDESTRIAN Super type for pedestrians.
static GTUType	TRAIN Super type for trains.
static GTUType	VEHICLE Super type for vehicles.

Constructor Summary

Constructors

Constructor and Description
GTUType(String id, GTUType parent)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId()
GTUType	getParent()
int	hashCode()
boolean	isOfType(GTUType gtuType) Whether this, or any of the parent GTU types, equals the given GTU type.
String	toString()

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

ALL

public static final GTUType ALL

ALL GTUType to be used only for permeability and accessibility.

NONE

public static final GTUType NONE

NONE GTUType to be used only for permeability and accessibility.

PEDESTRIAN

public static final GTUType PEDESTRIAN

Super type for pedestrians.

BIKE

public static final GTUType BIKE

Super type for bikes.

VEHICLE

public static final GTUType VEHICLE

Super type for vehicles.

BOAT

public static final GTUType BOAT

Super type for boats.

TRAIN

public static final GTUType TRAIN

Super type for trains.

Constructor Detail

GTUType

public GTUType(String id,
               GTUType parent)
        throws NullPointerException

Parameters:

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

parent - GTUType; parent GTU type

Throws:

NullPointerException - if the id is null

Method Detail

getId

public String getId()

Returns:

id.

getParent

public GTUType getParent()

Returns:

parent.

isOfType

public boolean isOfType(GTUType gtuType)

Whether this, or any of the parent GTU types, equals the given GTU type.

Parameters:

gtuType - GTUType; gtu type

Returns:

whether this, or any of the parent GTU types, equals the given GTU type

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