gov.nasa.gsfc.spdf.ssc
Enum MapProjection

java.lang.Object
  java.lang.Enum<MapProjection>
      gov.nasa.gsfc.spdf.ssc.MapProjection

All Implemented Interfaces:

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

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

This class represents the map projections supported by SSC.

Note: The integer values for this enumeration cannot be arbitrarily assigned. They must match the values expected by other parts of the SSC software.

Version:

$Revison: $

Author:

B. Harris

Enum Constant Summary

AZIMUTHAL
Azimuthal projection.

CYLINDRICAL
Cylindrical projection.

MERCATOR
Mercator projection.

MOLLEWEIDE
Molleweide projection.

ORTHOGRAPHIC
Orthographic projection.

STEREOGRAPHIC
Stereographic projection.

Method Summary

static MapProjection	fromValue(int value) Provides the PolarMapOrientation corresponding to the given integer value.
java.lang.String	toString() Provides a string representation of this projection.
int	value() Provides the integer value corresponding to this projection.
static MapProjection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MapProjection[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CYLINDRICAL

public static final MapProjection CYLINDRICAL

Cylindrical projection.

MERCATOR

public static final MapProjection MERCATOR

Mercator projection.

MOLLEWEIDE

public static final MapProjection MOLLEWEIDE

Molleweide projection.

STEREOGRAPHIC

public static final MapProjection STEREOGRAPHIC

Stereographic projection.

ORTHOGRAPHIC

public static final MapProjection ORTHOGRAPHIC

Orthographic projection.

AZIMUTHAL

public static final MapProjection AZIMUTHAL

Azimuthal projection.

Method Detail

values

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

Returns:

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

valueOf

public static MapProjection 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

value

public int value()

Provides the integer value corresponding to this projection.

Returns:

integer value corrsponding to this projection.

fromValue

public static MapProjection fromValue(int value)

Provides the PolarMapOrientation corresponding to the given integer value.

Parameters:

value - integer value corresponding to a projection

Returns:

PolarMapOrientation corresponding to the given value

Throws:

java.lang.IllegalArgumentException - if the given value does not correspond to any projection

toString

public java.lang.String toString()

Provides a string representation of this projection.

Overrides:

toString in class java.lang.Enum<MapProjection>

Returns:

a string representation of this projection