Enum Class HealpixTableInfo.HpxCoordSys

java.lang.Object
java.lang.Enum<HealpixTableInfo.HpxCoordSys>
uk.ac.starlink.table.HealpixTableInfo.HpxCoordSys
All Implemented Interfaces:
Serializable, Comparable<HealpixTableInfo.HpxCoordSys>, Constable
Enclosing class:
HealpixTableInfo

public static enum HealpixTableInfo.HpxCoordSys extends Enum<HealpixTableInfo.HpxCoordSys>
Characterises the coordinate systems defined by the HEALpix-FITS serialization convention. These are the values permitted for the HEALPix-FITS COORDSYS keyword.
See Also:
  • Enum Constant Details

  • Method Details

    • values

      public static HealpixTableInfo.HpxCoordSys[] 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 HealpixTableInfo.HpxCoordSys 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
    • getCharString

      public String getCharString()
      Returns the 1-character string used to label this system in the FITS serialization.
      Returns:
      1-character string
    • getWord

      public String getWord()
      Returns a human-readable short description of this system.
      Returns:
      description
    • fromCharacter

      public static HealpixTableInfo.HpxCoordSys fromCharacter(char c)
      Returns the instance of this class corresponding to a character label (as used in the FITS serialization). Null is returned if the character is not known.
      Parameters:
      c - coordinate system label
      Returns:
      coordinate system object, or null