Package cds.healpix
Enum Class CompassPoint.MainWind
- All Implemented Interfaces:
Serializable
,Comparable<CompassPoint.MainWind>
,Constable
- Enclosing class:
- CompassPoint
Enum defining the compass main wind points.
- Author:
- F.-X. Pineau
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionReturns the opposite direction.boolean
Returnstrue
is this main wind direction is a cardinal point.boolean
Returnstrue
is this main wind direction is an ordinal point.Returns the equivalent cardinal point in theCompassPoint.Cardinal
enum.Returns the equivalent ordinal point in theCompassPoint.Ordinal
enum (throws an IllegalArgumentException if the direction is not an ordinal point).static CompassPoint.MainWind
Returns the enum constant of this class with the specified name.static CompassPoint.MainWind[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
N
North. -
NE
Northeast. -
E
East. -
SE
Southeast. -
S
South. -
SW
Southwest. -
W
West. -
NW
Northwest. -
C
Center.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOppositeDirection
Returns the opposite direction.- Returns:
- the opposite direction.
-
isOrdinal
public boolean isOrdinal()Returnstrue
is this main wind direction is an ordinal point.- Returns:
true
is this main wind direction is an ordinal point.
-
toOrdinal
Returns the equivalent ordinal point in theCompassPoint.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()Returnstrue
is this main wind direction is a cardinal point.- Returns:
true
is this main wind direction is a cardinal point.
-
toCardinal
Returns the equivalent cardinal point in theCompassPoint.Cardinal
enum. (throws an IllegalArgumentException if the direction is not an cardinal point.)- Returns:
- the equivalent cardinal point in the
CompassPoint.Cardinal
enum.
-