agi.foundation.terrain

(agi.foundation.terrainreaders-2023r1.jar)

Enum RasterTerrainGridCellDiagonal

java.lang.Object

java.lang.Enum<RasterTerrainGridCellDiagonal>

agi.foundation.terrain.RasterTerrainGridCellDiagonal

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RasterTerrainGridCellDiagonal>

public enum RasterTerrainGridCellDiagonal
extends Enum<RasterTerrainGridCellDiagonal>
implements Enumeration

Defines the direction of a diagonal across a raster terrain grid cell.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORTHWEST_TO_SOUTHEAST_CORNER The cell is bisected from the northwest to the southeast corner.
SOUTHWEST_TO_NORTHEAST_CORNER The cell is bisected from the southwest to the northeast corner.

Method Summary

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

NORTHWEST_TO_SOUTHEAST_CORNER

public static final RasterTerrainGridCellDiagonal NORTHWEST_TO_SOUTHEAST_CORNER

The cell is bisected from the northwest to the southeast corner.

SOUTHWEST_TO_NORTHEAST_CORNER

public static final RasterTerrainGridCellDiagonal SOUTHWEST_TO_NORTHEAST_CORNER

The cell is bisected from the southwest to the northeast corner.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.