Package org.opentrafficsim.road.gtu.lane.tactical

Enum Controllable.State

java.lang.Object

java.lang.Enum<Controllable.State>

org.opentrafficsim.road.gtu.lane.tactical.Controllable.State

All Implemented Interfaces:

Serializable, Comparable<Controllable.State>

Enclosing interface:

Controllable

public static enum Controllable.State
extends Enum<Controllable.State>

Control state.

Copyright (c) 2013-2022 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 May 1, 2019

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Control is disabled.
ENABLED	Control is enabled.
NONE	GTU has no control.

Method Summary

Modifier and Type	Method	Description
boolean	isDisabled()	Returns whether this is DISABLED.
boolean	isEnabled()	Returns whether this is ENABLED.
boolean	isNone()	Returns whether this is NONE.
static Controllable.State	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Controllable.State[]	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

NONE

public static final Controllable.State NONE

GTU has no control.

DISABLED

public static final Controllable.State DISABLED

Control is disabled.

ENABLED

public static final Controllable.State ENABLED

Control is enabled.

Method Detail

values

public static Controllable.State[] 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 (Controllable.State c : Controllable.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static Controllable.State 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

isNone

public boolean isNone()

Returns whether this is NONE.

Returns:

boolean; whether this is NONE

isDisabled

public boolean isDisabled()

Returns whether this is DISABLED.

Returns:

boolean; whether this is DISABLED

isEnabled

public boolean isEnabled()

Returns whether this is ENABLED.

Returns:

boolean; whether this is ENABLED