Enum LatLonFormat

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LatLonFormat>

    public enum LatLonFormat
    extends java.lang.Enum<LatLonFormat>
    This class represents the latitude/longitude formats 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
      LAT_90_LON_180
      A format of latitude (-90,+90) and longitude (-180,+180).
      LAT_90_LON_360
      A format of latitude (-90,+90) and longitude (0,360).
      LAT_90_SN_LON_180_WE
      A format of latitude (90S,90N) and longitude (180W,180E).
    • Method Summary

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

      • LAT_90_LON_360

        public static final LatLonFormat LAT_90_LON_360
        A format of latitude (-90,+90) and longitude (0,360).
      • LAT_90_LON_180

        public static final LatLonFormat LAT_90_LON_180
        A format of latitude (-90,+90) and longitude (-180,+180).
      • LAT_90_SN_LON_180_WE

        public static final LatLonFormat LAT_90_SN_LON_180_WE
        A format of latitude (90S,90N) and longitude (180W,180E).
    • Method Detail

      • values

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

        public static LatLonFormat 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 latitude/longitude format.
        Returns:
        integer value corrsponding to this latitude/longitude format.
      • fromValue

        public static LatLonFormat fromValue​(int value)
        Provides the latitude/longitude format corresponding to the given integer value.
        Parameters:
        value - integer value corresponding to a latitude/longitude format
        Returns:
        LatLonFormat corresponding to the given value
        Throws:
        java.lang.IllegalArgumentException - if the given value does not correspond to any latitude/longitude format
      • toString

        public java.lang.String toString()
        Provides a string representation of this latitude/longitude format.
        Overrides:
        toString in class java.lang.Enum<LatLonFormat>
        Returns:
        a string representation of this latitude/longitude format