Package cds.healpix

Enum CompassPoint.MainWind

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CompassPoint.MainWind>
    Enclosing class:
    CompassPoint

    public static enum CompassPoint.MainWind
    extends java.lang.Enum<CompassPoint.MainWind>
    Enum defining the compass main wind points.
    Author:
    F.-X. Pineau
    • Method Detail

      • values

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

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