Package cds.healpix

Enum Class CompassPoint.MainWind

java.lang.Object
java.lang.Enum<CompassPoint.MainWind>
cds.healpix.CompassPoint.MainWind
All Implemented Interfaces:
Serializable, Comparable<CompassPoint.MainWind>, Constable
Enclosing class:
CompassPoint
public static enum CompassPoint.MainWind extends Enum<CompassPoint.MainWind>
Enum defining the compass main wind points.
Author:
F.-X. Pineau

  • Enum Constant Details

  • Method Details

    • values

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

    • getOppositeDirection

      public CompassPoint.MainWind getOppositeDirection()
      Returns the opposite direction.
      Returns:
      the opposite direction.

    • isOrdinal

      public boolean isOrdinal()
      Returns true is this main wind direction is an ordinal point.
      Returns:
      true is this main wind direction is an ordinal point.

    • toOrdinal

      public CompassPoint.Ordinal toOrdinal()
      Returns the equivalent ordinal point in the CompassPoint.Ordinal enum (throws an IllegalArgumentException if the direction is not an ordinal point).
      Returns:
      the equivalent ordinal point in the CompassPoint.Ordinal enum.

    • isCardinal

      public boolean isCardinal()
      Returns true is this main wind direction is a cardinal point.
      Returns:
      true is this main wind direction is a cardinal point.

    • toCardinal

      public CompassPoint.Cardinal toCardinal()
      Returns the equivalent cardinal point in the CompassPoint.Cardinal enum. (throws an IllegalArgumentException if the direction is not an cardinal point.)
      Returns:
      the equivalent cardinal point in the CompassPoint.Cardinal enum.