prajna.geo

Enum Geoid

java.lang.Object

java.lang.Enum<Geoid>

prajna.geo.Geoid

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Geoid>

public enum Geoid
extends java.lang.Enum<Geoid>

This enumeration provides parameters representing USGS Geoid measurements for the earth. It can also represent other planets.

Author:

Edward Swing

Enum Constant Summary

Enum Constants

Enum Constant and Description
EARTH_SPHERE
EARTH_WGS72
EARTH_WGS84

Method Summary

Methods

Modifier and Type	Method and Description
double	eccentricity() Get the eccentricity of the geoid
double	polarRadius() Calculate the polar radius of the geoid, in meters.
double	radius() Get the equatorial radius of the geoid, in meters.
static Geoid	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Geoid[]	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

EARTH_SPHERE

public static final Geoid EARTH_SPHERE

EARTH_WGS84

public static final Geoid EARTH_WGS84

EARTH_WGS72

public static final Geoid EARTH_WGS72

Method Detail

values

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

Returns:

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

valueOf

public static Geoid valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

eccentricity

public double eccentricity()

Get the eccentricity of the geoid

Returns:

the eccentricity

polarRadius

public double polarRadius()

Calculate the polar radius of the geoid, in meters.

Returns:

the polar radius of the geoid

radius

public double radius()

Get the equatorial radius of the geoid, in meters.

Returns:

the equatorial radius of the geoid