Package gov.nasa.gsfc.sscweb.schema

# Enum Class MapProjectionTrace

java.lang.Object
java.lang.Enum<MapProjectionTrace>
gov.nasa.gsfc.sscweb.schema.MapProjectionTrace

All Implemented Interfaces:
  `Serializable`, `Comparable<MapProjectionTrace>`, `Constable`

public enum MapProjectionTrace extends Enum<MapProjectionTrace>
Mapped projection trace options supported by SSC. <p>Java class for MapProjectionTrace</p>. <p>The following schema fragment specifies the expected content contained within this class.</p> <pre>{@code <simpleType name="MapProjectionTrace"> <restriction base="{http://www.w3.org/2001/XMLSchema}string"> <enumeration value="BFieldNorth"/> <enumeration value="BFieldSouth"/> <enumeration value="Radial"/> </restriction> </simpleType> }</pre>

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `B_FIELD_NORTH`
  A trace from the satellite's location along the intersection north magnetic field line.
  `B_FIELD_SOUTH`
  A trace from the satellite's location along the intersection south magnetic field line.
  `RADIAL`
  A radial trace from the center of the Earth to the satellite.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `private final String`
  `value`

- ## Constructor Summary

  Constructors
  Modifier
  Constructor
  Description
  `private`
  `MapProjectionTrace(String v)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static MapProjectionTrace`
  `fromValue(String v)`
  Gets the enum associated to the value passed as parameter.
  `String`
  `value()`
  Gets the value associated to the enum constant.
  `static MapProjectionTrace`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static MapProjectionTrace[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### B_FIELD_NORTH

    public static final MapProjectionTrace B_FIELD_NORTH
    A trace from the satellite's location along the intersection north magnetic field line.

  - ### B_FIELD_SOUTH

    public static final MapProjectionTrace B_FIELD_SOUTH
    A trace from the satellite's location along the intersection south magnetic field line.

  - ### RADIAL

    public static final MapProjectionTrace RADIAL
    A radial trace from the center of the Earth to the satellite.

- ## Field Details

  - ### value

    private final String value

- ## Constructor Details

  - ### MapProjectionTrace

    private MapProjectionTrace(String v)

- ## Method Details

  - ### values

    public static MapProjectionTrace[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static MapProjectionTrace valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      `IllegalArgumentException` - if this enum class has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### value

    public String value()
    Gets the value associated to the enum constant.
    Returns:
      The value linked to the enum.

  - ### fromValue

    public static MapProjectionTrace fromValue(String v)
    Gets the enum associated to the value passed as parameter.
    Parameters:
      `v` - The value to get the enum from.
    Returns:
      The enum which corresponds to the value, if it exists.
    Throws:
      `IllegalArgumentException` - If no value matches in the enum declaration.