org.opentrafficsim.road.gtu.lane.perception.categories

Enum HeadwayGtuType

java.lang.Object

java.lang.Enum<HeadwayGtuType>

org.opentrafficsim.road.gtu.lane.perception.categories.HeadwayGtuType

All Implemented Interfaces:

Serializable, Comparable<HeadwayGtuType>

public enum HeadwayGtuType
extends Enum<HeadwayGtuType>

Whether a GTU needs to be wrapped, or information should be copied for later and unaltered use.

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.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 24 mrt. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY Info regarding the GTU is copied.
WRAP The GTU is wrapped, and info is taken directly from it.

Method Summary

Modifier and Type	Method and Description
abstract HeadwayGTU	createHeadwayGtu(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Length distance) Creates a headway object from a GTU, downstream or upstream.
abstract HeadwayGTU	createHeadwayGtu(LaneBasedGTU gtu, org.djunits.value.vdouble.scalar.Length overlapFront, org.djunits.value.vdouble.scalar.Length overlap, org.djunits.value.vdouble.scalar.Length overlapRear) Creates a headway object from a GTU, parallel.
static HeadwayGtuType	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeadwayGtuType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WRAP

public static final HeadwayGtuType WRAP

The GTU is wrapped, and info is taken directly from it.

COPY

public static final HeadwayGtuType COPY

Info regarding the GTU is copied.

Method Detail

values

public static HeadwayGtuType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HeadwayGtuType c : HeadwayGtuType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HeadwayGtuType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

createHeadwayGtu

public abstract HeadwayGTU createHeadwayGtu(LaneBasedGTU gtu,
                                            org.djunits.value.vdouble.scalar.Length distance)
                                     throws org.opentrafficsim.core.gtu.GTUException

Creates a headway object from a GTU, downstream or upstream.

Parameters:

gtu - gtu

distance - distance

Returns:

headway object from a gtu

Throws:

org.opentrafficsim.core.gtu.GTUException - when headway object cannot be created

createHeadwayGtu

public abstract HeadwayGTU createHeadwayGtu(LaneBasedGTU gtu,
                                            org.djunits.value.vdouble.scalar.Length overlapFront,
                                            org.djunits.value.vdouble.scalar.Length overlap,
                                            org.djunits.value.vdouble.scalar.Length overlapRear)
                                     throws org.opentrafficsim.core.gtu.GTUException

Creates a headway object from a GTU, parallel.

Parameters:

gtu - gtu

overlapFront - front overlap

overlap - overlap

overlapRear - rear overlap

Returns:

headway object from a gtu

Throws:

org.opentrafficsim.core.gtu.GTUException - when headway object cannot be created