Package gov.nasa.gsfc.spdf.ssc

Enum CoordinateSystem

java.lang.Object

java.lang.Enum<CoordinateSystem>

gov.nasa.gsfc.spdf.ssc.CoordinateSystem

All Implemented Interfaces:

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

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

This class represents the different coordinate systems supported by SSC.

Version:

$Revison: $

Author:

B. Harris

Enum Constant Summary

Enum Constants

Enum Constant	Description
GEI_J2000	Geocentric Equatorial Inertial coordinate system with a Julian 2000 equinox epoch.
GEI_TOD	Geocentric Equatorial Inertial coordinate system with a true-of-date equinox epoch.
GEO	Geographic coordinate system (see Description of Selected Coordinate Systems Used in SSC Programs).
GM	Geomagnetic coordinate system (see Description of Selected Coordinate Systems Used in SSC Programs).
GSE	Geocentric Solar Ecliptic system (see Description of Selected Coordinate Systems Used in SSC Programs).
GSM	Geocentric Solar Magnetospheric system (see Description of Selected Coordinate Systems Used in SSC Programs).
SM	Solar Magnetic coordinates (see Description of Selected Coordinate Systems Used in SSC Programs).

Method Summary

Modifier and Type	Method	Description
static CoordinateSystem	fromValue(java.lang.String name)	Provides the CoordinateSystem corresponding to the given String value.
java.lang.String	value()	Provides a String value corresponding to this coordinate system.
static CoordinateSystem	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CoordinateSystem[]	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

GEI_TOD

public static final CoordinateSystem GEI_TOD

Geocentric Equatorial Inertial coordinate system with a true-of-date equinox epoch. See Description of Selected Coordinate Systems Used in SSC Programs).

GEI_J2000

public static final CoordinateSystem GEI_J2000

Geocentric Equatorial Inertial coordinate system with a Julian 2000 equinox epoch. See Description of Selected Coordinate Systems Used in SSC Programs).

GEO

public static final CoordinateSystem GEO

Geographic coordinate system (see Description of Selected Coordinate Systems Used in SSC Programs).

GM

public static final CoordinateSystem GM

Geomagnetic coordinate system (see Description of Selected Coordinate Systems Used in SSC Programs).

GSE

public static final CoordinateSystem GSE

Geocentric Solar Ecliptic system (see Description of Selected Coordinate Systems Used in SSC Programs).

GSM

public static final CoordinateSystem GSM

Geocentric Solar Magnetospheric system (see Description of Selected Coordinate Systems Used in SSC Programs).

SM

public static final CoordinateSystem SM

Solar Magnetic coordinates (see Description of Selected Coordinate Systems Used in SSC Programs).

Method Detail

values

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

Returns:

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

valueOf

public static CoordinateSystem 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 java.lang.String value()

Provides a String value corresponding to this coordinate system.

Returns:

String value corresponding to this coordinate system

fromValue

public static CoordinateSystem fromValue(java.lang.String name)

Provides the CoordinateSystem corresponding to the given String value.

Parameters:

name - String value corresponding to a CoordinateSystem

Returns:

CoordinateSystem corresponding to the given name

Throws:

java.lang.IllegalArgumentException - if the given name does not correspond to any CoordinateSystem