public enum FootpointRegion extends java.lang.Enum<FootpointRegion>
Note: The integer values for this enumeration cannot be arbitrarily assigned. They must match the values expected by other parts of the SSC software.
Enum Constant and 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).
|
Modifier and Type | Method and 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.
|
public static final FootpointRegion NOT_APPLICABLE
public static final FootpointRegion NORTH_CUSP
public static final FootpointRegion SOUTH_CUSP
public static final FootpointRegion NORTH_CLEFT
public static final FootpointRegion SOUTH_CLEFT
public static final FootpointRegion NORTH_AURORAL_OVAL
public static final FootpointRegion SOUTH_AURORAL_OVAL
public static final FootpointRegion NORTH_POLAR_CAP
public static final FootpointRegion SOUTH_POLAR_CAP
public static final FootpointRegion NORTH_MID_LATITUDE
public static final FootpointRegion SOUTH_MID_LATITUDE
public static final FootpointRegion LOW_LATITUDE
public static FootpointRegion[] values()
for (FootpointRegion c : FootpointRegion.values()) System.out.println(c);
public static FootpointRegion valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic int value()
public static FootpointRegion fromValue(int value)
value
- integer value corresponding to a footpoint regionjava.lang.IllegalArgumentException
- if the given value does not
correspond to any footpoint regionpublic java.lang.String toString()
toString
in class java.lang.Enum<FootpointRegion>
SSC Feedback.
Copyright © 2003-2018 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.