agi.foundation.routedesign.advanced

(agi.foundation.routedesign-2024r1.jar)

Enum SpeedConfigurationStatus

java.lang.Object

java.lang.Enum<SpeedConfigurationStatus>

agi.foundation.routedesign.advanced.SpeedConfigurationStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SpeedConfigurationStatus>

public enum SpeedConfigurationStatus
extends Enum<SpeedConfigurationStatus>
implements Enumeration

An enumeration indicating the status of the configuration of speed information between route segments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH_SPEEDS_UNMATCHED Both the initial and final speeds of the current profile do not match the surrounding profiles.
DYNAMICS_MATCH The dynamics match between the segments.
FINAL_SPEED_UNMATCHED The final speed of the current profile is discontinuous.
INITIAL_SPEED_UNMATCHED The initial speed of the current profile is discontinuous.
UNKNOWN An unknown error occurred while trying to configure the segment.
VIOLATES_PROFILE_DYNAMICS The profile cannot match the dynamics at either the initial or final conditions.

Method Summary

Modifier and Type	Method and Description
static SpeedConfigurationStatus	getDefault() Get the enum constant that is considered to be the default.
static SpeedConfigurationStatus	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static SpeedConfigurationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpeedConfigurationStatus[]	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

DYNAMICS_MATCH

public static final SpeedConfigurationStatus DYNAMICS_MATCH

The dynamics match between the segments.

INITIAL_SPEED_UNMATCHED

public static final SpeedConfigurationStatus INITIAL_SPEED_UNMATCHED

The initial speed of the current profile is discontinuous.

FINAL_SPEED_UNMATCHED

public static final SpeedConfigurationStatus FINAL_SPEED_UNMATCHED

The final speed of the current profile is discontinuous.

BOTH_SPEEDS_UNMATCHED

public static final SpeedConfigurationStatus BOTH_SPEEDS_UNMATCHED

Both the initial and final speeds of the current profile do not match the surrounding profiles.

VIOLATES_PROFILE_DYNAMICS

public static final SpeedConfigurationStatus VIOLATES_PROFILE_DYNAMICS

The profile cannot match the dynamics at either the initial or final conditions. Usually this is because either the segment is too short or the acceleration of the position is insufficient.

UNKNOWN

public static final SpeedConfigurationStatus UNKNOWN

An unknown error occurred while trying to configure the segment. The results may include discontinuities.

Method Detail

values

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

Returns:

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

valueOf

public static SpeedConfigurationStatus 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static SpeedConfigurationStatus getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static SpeedConfigurationStatus getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.