org.spase.parser120
Enum EnumMagnetosphere

java.lang.Object
  java.lang.Enum<EnumMagnetosphere>
      org.spase.parser120.EnumMagnetosphere

All Implemented Interfaces:

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

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

Java class for enumMagnetosphere.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="enumMagnetosphere">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="Magnetotail"/>
     <enumeration value="Main"/>
     <enumeration value="Polar"/>
     <enumeration value="RadiationBelt"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

MAGNETOTAIL
The region on the night side of the body where the magnetic filed is stretched backwards by the force of the solar wind.

MAIN
The region of the magnetosphere where the magnetic field lines are closed, but does not include the gaseous region gravitationally bound to the body.

POLAR
The region near the pole of a body.

RADIATION_BELT
The region within a magnetosphere where high-energy particles could potentially be trapped in a magnetic field.

Method Summary

static EnumMagnetosphere	fromValue(java.lang.String v)
java.lang.String	value()
static EnumMagnetosphere	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumMagnetosphere[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAGNETOTAIL

public static final EnumMagnetosphere MAGNETOTAIL

The region on the night side of the body where the magnetic filed is stretched backwards by the force of the solar wind. For Earth, the magnetotail begins at a night-side radial distance of 10 Re (X > -10Re).

MAIN

public static final EnumMagnetosphere MAIN

The region of the magnetosphere where the magnetic field lines are closed, but does not include the gaseous region gravitationally bound to the body.

POLAR

public static final EnumMagnetosphere POLAR

The region near the pole of a body. For a magnetosphere the polar region is the area where magnetic field lines are open and includes the aural zone.

RADIATION_BELT

public static final EnumMagnetosphere RADIATION_BELT

The region within a magnetosphere where high-energy particles could potentially be trapped in a magnetic field.

Method Detail

values

public static final EnumMagnetosphere[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(EnumMagnetosphere c : EnumMagnetosphere.values())
        System.out.println(c);

Returns:

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

valueOf

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

value

public java.lang.String value()

fromValue

public static EnumMagnetosphere fromValue(java.lang.String v)