Package gov.nasa.gsfc.sscweb.schema

# Enum Class BFieldTraceDirection

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

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

public enum BFieldTraceDirection extends Enum<BFieldTraceDirection>
Trace direction enumeration. <p>Java class for BFieldTraceDirection</p>. <p>The following schema fragment specifies the expected content contained within this class.</p> <pre>{@code <simpleType name="BFieldTraceDirection"> <restriction base="{http://www.w3.org/2001/XMLSchema}string"> <enumeration value="SameHemisphere"/> <enumeration value="OppositeHemisphere"/> <enumeration value="NorthHemisphere"/> <enumeration value="SouthHemisphere"/> <enumeration value="EitherHemisphere"/> </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
  `EITHER_HEMISPHERE`
  Trace in either or both magnetic hemispheres.
  `NORTH_HEMISPHERE`
  Trace in the north magnetic hemisphere.
  `OPPOSITE_HEMISPHERE`
  Trace in the opposite magnetic hemisphere.
  `SAME_HEMISPHERE`
  Trace in the same magnetic hemisphere.
  `SOUTH_HEMISPHERE`
  Trace in the south magnetic hemisphere.

- ## Field Summary

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

- ## Constructor Summary

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

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static BFieldTraceDirection`
  `fromValue(String v)`
  Gets the enum associated to the value passed as parameter.
  `String`
  `value()`
  Gets the value associated to the enum constant.
  `static BFieldTraceDirection`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static BFieldTraceDirection[]`
  `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

  - ### SAME_HEMISPHERE

    public static final BFieldTraceDirection SAME_HEMISPHERE
    Trace in the same magnetic hemisphere.

  - ### OPPOSITE_HEMISPHERE

    public static final BFieldTraceDirection OPPOSITE_HEMISPHERE
    Trace in the opposite magnetic hemisphere.

  - ### NORTH_HEMISPHERE

    public static final BFieldTraceDirection NORTH_HEMISPHERE
    Trace in the north magnetic hemisphere.

  - ### SOUTH_HEMISPHERE

    public static final BFieldTraceDirection SOUTH_HEMISPHERE
    Trace in the south magnetic hemisphere.

  - ### EITHER_HEMISPHERE

    public static final BFieldTraceDirection EITHER_HEMISPHERE
    Trace in either or both magnetic hemispheres.

- ## Field Details

  - ### value

    private final String value

- ## Constructor Details

  - ### BFieldTraceDirection

    private BFieldTraceDirection(String v)

- ## Method Details

  - ### values

    public static BFieldTraceDirection[] 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 BFieldTraceDirection 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 BFieldTraceDirection 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.