agi.foundation.routedesign.advanced

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

Enum SurfaceConnectionStatus

java.lang.Object

java.lang.Enum<SurfaceConnectionStatus>

agi.foundation.routedesign.advanced.SurfaceConnectionStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SurfaceConnectionStatus>

public enum SurfaceConnectionStatus
extends Enum<SurfaceConnectionStatus>
implements Enumeration

An enumeration indicating the status of the configuration of the surface geometry.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURED_CORRECTLY The geometry was configured successfully.
CONNECTION_IS_IMPOSSIBLE The current connection is impossible without discontinuity.
NEXT_CONNECTION_UNCONFIGURED There was a problem with the next connection or it does not exist.
PREVIOUS_CONNECTION_UNCONFIGURED There was a problem with the previous connection or it does not exist.
UNKNOWN There was an unknown error with the configuration.

Method Summary

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

CONFIGURED_CORRECTLY

public static final SurfaceConnectionStatus CONFIGURED_CORRECTLY

The geometry was configured successfully.

CONNECTION_IS_IMPOSSIBLE

public static final SurfaceConnectionStatus CONNECTION_IS_IMPOSSIBLE

The current connection is impossible without discontinuity. This is usually caused by either two turns occurring too close together or where other constraints cannot be resolved during configuration.

PREVIOUS_CONNECTION_UNCONFIGURED

public static final SurfaceConnectionStatus PREVIOUS_CONNECTION_UNCONFIGURED

There was a problem with the previous connection or it does not exist.

NEXT_CONNECTION_UNCONFIGURED

public static final SurfaceConnectionStatus NEXT_CONNECTION_UNCONFIGURED

There was a problem with the next connection or it does not exist.

UNKNOWN

public static final SurfaceConnectionStatus UNKNOWN

There was an unknown error with the configuration. Discontinuities may exist in the resulting surface path.

Method Detail

values

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

Returns:

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

valueOf

public static SurfaceConnectionStatus 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 SurfaceConnectionStatus 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 SurfaceConnectionStatus getDefault()

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

Returns:

The default enum constant.