Package uk.ac.starlink.ttools.plot2.layer

Enum AngleUnit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AngleUnit>
    public enum AngleUnit
extends java.lang.Enum<AngleUnit>
    Defines units in which angular extents can be specified.
    Since:
    2 Aug 2017
    Author:
    Mark Taylor

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ARCSEC
      Arcseconds.
      DEGREE
      Degrees.
      MAS
      Milliarcseconds.
      MINUTE
      Minutes.
      RADIAN
      Radians.
      UAS
      Microarcseconds.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFullName()
      Returns the full-text name of this unit.
      java.lang.String getName()
      Returns the canonical name of this unit.
      static AngleUnit getNamedUnit​(java.lang.String name)
      Returns the AngleUnit instance that corresponds to a user-specified unit name.
      double getValueInDegrees()
      Returns the value of this unit in degrees.
      java.lang.String toString()  
      static AngleUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AngleUnit[] 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

      • RADIAN

        public static final AngleUnit RADIAN
        Radians.

      • DEGREE

        public static final AngleUnit DEGREE
        Degrees.

      • MINUTE

        public static final AngleUnit MINUTE
        Minutes.

      • ARCSEC

        public static final AngleUnit ARCSEC
        Arcseconds.

      • MAS

        public static final AngleUnit MAS
        Milliarcseconds.

      • UAS

        public static final AngleUnit UAS
        Microarcseconds.

    • Method Detail

      • values

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

      • valueOf

        public static AngleUnit 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

      • getValueInDegrees

        public double getValueInDegrees()
        Returns the value of this unit in degrees.
        Returns:
        value in degrees

      • getName

        public java.lang.String getName()
        Returns the canonical name of this unit.
        Returns:
        unit name

      • getFullName

        public java.lang.String getFullName()
        Returns the full-text name of this unit.
        Returns:
        full unit name

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<AngleUnit>

      • getNamedUnit

        public static AngleUnit getNamedUnit​(java.lang.String name)
        Returns the AngleUnit instance that corresponds to a user-specified unit name.
        Parameters:
        name - user-specified name
        Returns:
        named AngleUnit, or null