agi.foundation.coordinates

(agi.foundation.core-2024r2.jar)

Enum SphericalElement

java.lang.Object

java.lang.Enum<SphericalElement>

agi.foundation.coordinates.SphericalElement

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SphericalElement>

public enum SphericalElement
extends Enum<SphericalElement>
implements Enumeration

The elements in a Spherical coordinates.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOCK The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
CONE The angular coordinate measured from the positive z-axis and toward the negative z-axis.
MAGNITUDE The linear coordinate measured from the origin.

Method Summary

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

CLOCK

public static final SphericalElement CLOCK

The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. This can also be thought of as the right ascension.

CONE

public static final SphericalElement CONE

The angular coordinate measured from the positive z-axis and toward the negative z-axis. This can be thought of as the declination.

MAGNITUDE

public static final SphericalElement MAGNITUDE

The linear coordinate measured from the origin.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.