Package gov.nasa.gsfc.spdf.ssc

Enum FootpointRegion

java.lang.Object

java.lang.Enum<FootpointRegion>

gov.nasa.gsfc.spdf.ssc.FootpointRegion

All Implemented Interfaces:

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

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

This class represents the different footpoint regions 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

Enum Constants

Enum Constant	Description
LOW_LATITUDE	Low Latitude region (see SSC Models and Regions of Geospace).
NORTH_AURORAL_OVAL	Northern Auroral Oval region (see SSC Models and Regions of Geospace).
NORTH_CLEFT	Northern Cleft region (see SSC Models and Regions of Geospace).
NORTH_CUSP	Northern Cusp region (see SSC Models and Regions of Geospace).
NORTH_MID_LATITUDE	Northern Mid-Latitude region (see SSC Models and Regions of Geospace).
NORTH_POLAR_CAP	Northern Polar Cap region (see SSC Models and Regions of Geospace).
NOT_APPLICABLE	Region value for magnetic field traced footpoints indicating that the satellite was outside the magnetic field and therefore no field line trace could be performed.
SOUTH_AURORAL_OVAL	Southern Auroral Oval region (see SSC Models and Regions of Geospace).
SOUTH_CLEFT	Southern Cleft region (see SSC Models and Regions of Geospace).
SOUTH_CUSP	Northern Cusp region (see SSC Models and Regions of Geospace).
SOUTH_MID_LATITUDE	Southern Mid-Latitude region (see SSC Models and Regions of Geospace).
SOUTH_POLAR_CAP	Southern Polar Cap region (see SSC Models and Regions of Geospace).

Method Summary

Modifier and Type	Method	Description
static FootpointRegion	fromValue(int value)	Provides the footpoint region corresponding to the given integer value.
java.lang.String	toString()	Provides a string representation of this region.
int	value()	Provides the integer value corresponding to this footpoint region.
static FootpointRegion	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static FootpointRegion[]	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

NOT_APPLICABLE

public static final FootpointRegion NOT_APPLICABLE

Region value for magnetic field traced footpoints indicating that the satellite was outside the magnetic field and therefore no field line trace could be performed.

NORTH_CUSP

public static final FootpointRegion NORTH_CUSP

Northern Cusp region (see SSC Models and Regions of Geospace).

SOUTH_CUSP

public static final FootpointRegion SOUTH_CUSP

Northern Cusp region (see SSC Models and Regions of Geospace).

NORTH_CLEFT

public static final FootpointRegion NORTH_CLEFT

Northern Cleft region (see SSC Models and Regions of Geospace).

SOUTH_CLEFT

public static final FootpointRegion SOUTH_CLEFT

Southern Cleft region (see SSC Models and Regions of Geospace).

NORTH_AURORAL_OVAL

public static final FootpointRegion NORTH_AURORAL_OVAL

Northern Auroral Oval region (see SSC Models and Regions of Geospace).

SOUTH_AURORAL_OVAL

public static final FootpointRegion SOUTH_AURORAL_OVAL

Southern Auroral Oval region (see SSC Models and Regions of Geospace).

NORTH_POLAR_CAP

public static final FootpointRegion NORTH_POLAR_CAP

Northern Polar Cap region (see SSC Models and Regions of Geospace).

SOUTH_POLAR_CAP

public static final FootpointRegion SOUTH_POLAR_CAP

Southern Polar Cap region (see SSC Models and Regions of Geospace).

NORTH_MID_LATITUDE

public static final FootpointRegion NORTH_MID_LATITUDE

Northern Mid-Latitude region (see SSC Models and Regions of Geospace).

SOUTH_MID_LATITUDE

public static final FootpointRegion SOUTH_MID_LATITUDE

Southern Mid-Latitude region (see SSC Models and Regions of Geospace).

LOW_LATITUDE

public static final FootpointRegion LOW_LATITUDE

Low Latitude region (see SSC Models and Regions of Geospace).

Method Detail

values

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

Returns:

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

valueOf

public static FootpointRegion 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 footpoint region.

Returns:

integer value corrsponding to this footpoint region.

fromValue

public static FootpointRegion fromValue(int value)

Provides the footpoint region corresponding to the given integer value.

Parameters:

value - integer value corresponding to a footpoint region

Returns:

FootpointRegion corresponding to the given value

Throws:

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

toString

public java.lang.String toString()

Provides a string representation of this region.

Overrides:

toString in class java.lang.Enum<FootpointRegion>

Returns:

a string representation of this region