agi.foundation.routedesign

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

Enum KindOfSurfaceConnection

java.lang.Object

java.lang.Enum<KindOfSurfaceConnection>

agi.foundation.routedesign.KindOfSurfaceConnection

All Implemented Interfaces:

Enumeration, Serializable, Comparable<KindOfSurfaceConnection>

public enum KindOfSurfaceConnection
extends Enum<KindOfSurfaceConnection>
implements Enumeration

An enumeration indicating the kind of behavior to use when connecting surface procedures.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GEODESIC Connects by using the shortest distance.
RHUMB_LINE Connects by using a constant heading.

Method Summary

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

RHUMB_LINE

public static final KindOfSurfaceConnection RHUMB_LINE

Connects by using a constant heading. For long connections, this will appear to curve on the 3D surface but will produce a straight line on a 2D (Mercator) map.

GEODESIC

public static final KindOfSurfaceConnection GEODESIC

Connects by using the shortest distance. For long connections, this will seem straighter on the 3D surface but will produce a deflection in latitude on a 2D (Mercator) map.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.