Package gov.nasa.gsfc.spdf.ssc

Enum SpaceRegion

java.lang.Object

java.lang.Enum<SpaceRegion>

gov.nasa.gsfc.spdf.ssc.SpaceRegion

All Implemented Interfaces:

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

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

This class represents the different regions of space 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
DAYSIDE_MAGNETOSHEATH	Dayside magnetosheath (see SSC Models and Regions of Geospace).
DAYSIDE_MAGNETOSPHERE	Dayside Magnotosphere (see SSC Models and Regions of Geospace).
DAYSIDE_PLASMASPHERE	Dayside plasmasphere (see SSC Models and Regions of Geospace).
HIGH_LATITUDE_BOUNDARY_LAYER	High-latitude boundary layer (see SSC Models and Regions of Geospace).
INTERPLANETARY_MEDIUM	Interplanetary medium (see SSC Models and Regions of Geospace).
LOW_LATITUDE_BOUNDARY_LAYER	Low-latitude boundary layer (see SSC Models and Regions of Geospace).
NIGHTSIDE_MAGNETOSHEATH	Nightside magnetosheath (see SSC Models and Regions of Geospace).
NIGHTSIDE_MAGNETOSPHERE	Nightside Magnotosphere (see SSC Models and Regions of Geospace).
NIGHTSIDE_PLASMASPHERE	Nightside plasmasphere (see SSC Models and Regions of Geospace).
PLASMA_SHEET	Plasma sheet (see SSC Models and Regions of Geospace).
TAIL_LOBE	Tail lobe (see SSC Models and Regions of Geospace).

Method Summary

Modifier and Type	Method	Description
static SpaceRegion	fromValue(int value)	Provides the space 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 space region.
static SpaceRegion	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SpaceRegion[]	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

INTERPLANETARY_MEDIUM

public static final SpaceRegion INTERPLANETARY_MEDIUM

Interplanetary medium (see SSC Models and Regions of Geospace).

DAYSIDE_MAGNETOSHEATH

public static final SpaceRegion DAYSIDE_MAGNETOSHEATH

Dayside magnetosheath (see SSC Models and Regions of Geospace).

NIGHTSIDE_MAGNETOSHEATH

public static final SpaceRegion NIGHTSIDE_MAGNETOSHEATH

Nightside magnetosheath (see SSC Models and Regions of Geospace).

DAYSIDE_MAGNETOSPHERE

public static final SpaceRegion DAYSIDE_MAGNETOSPHERE

Dayside Magnotosphere (see SSC Models and Regions of Geospace).

NIGHTSIDE_MAGNETOSPHERE

public static final SpaceRegion NIGHTSIDE_MAGNETOSPHERE

Nightside Magnotosphere (see SSC Models and Regions of Geospace).

PLASMA_SHEET

public static final SpaceRegion PLASMA_SHEET

Plasma sheet (see SSC Models and Regions of Geospace).

TAIL_LOBE

public static final SpaceRegion TAIL_LOBE

Tail lobe (see SSC Models and Regions of Geospace).

LOW_LATITUDE_BOUNDARY_LAYER

public static final SpaceRegion LOW_LATITUDE_BOUNDARY_LAYER

Low-latitude boundary layer (see SSC Models and Regions of Geospace).

HIGH_LATITUDE_BOUNDARY_LAYER

public static final SpaceRegion HIGH_LATITUDE_BOUNDARY_LAYER

High-latitude boundary layer (see SSC Models and Regions of Geospace).

DAYSIDE_PLASMASPHERE

public static final SpaceRegion DAYSIDE_PLASMASPHERE

Dayside plasmasphere (see SSC Models and Regions of Geospace).

NIGHTSIDE_PLASMASPHERE

public static final SpaceRegion NIGHTSIDE_PLASMASPHERE

Nightside plasmasphere (see SSC Models and Regions of Geospace).

Method Detail

values

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

Returns:

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

valueOf

public static SpaceRegion 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 space region.

Returns:

integer value corrsponding to this space region.

fromValue

public static SpaceRegion fromValue(int value)

Provides the space region corresponding to the given integer value.

Parameters:

value - integer value corresponding to a space region

Returns:

SpaceRegion corresponding to the given value

Throws:

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

toString

public java.lang.String toString()

Provides a string representation of this region.

Overrides:

toString in class java.lang.Enum<SpaceRegion>

Returns:

a string representation of this region