Package gov.nasa.gsfc.spdf.ssc

Enum Trace

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Trace>
    public enum Trace
extends java.lang.Enum<Trace>
    This class represents the different mapped projection trace options 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
      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.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Trace fromValue​(int value)
      Provides the Trace option corresponding to the given integer value.
      java.lang.String toString()
      Provides a string representation of this Trace option.
      int value()
      Provides the integer value corresponding to this Trace option.
      static Trace valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Trace[] 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

      • RADIAL

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

      • B_FIELD_NORTH

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

      • B_FIELD_SOUTH

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

    • Method Detail

      • values

        public static Trace[] 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 (Trace c : Trace.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Trace 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 Trace option.
        Returns:
        integer value corrsponding to this Trace option.

      • fromValue

        public static Trace fromValue​(int value)
        Provides the Trace option corresponding to the given integer value.
        Parameters:
        value - integer value corresponding to a Trace option
        Returns:
        Trace corresponding to the given value
        Throws:
        java.lang.IllegalArgumentException - if the given value does not correspond to any Trace option

      • toString

        public java.lang.String toString()
        Provides a string representation of this Trace option.
        Overrides:
        toString in class java.lang.Enum<Trace>
        Returns:
        a string representation of this Trace option