HurricaneEnum

java.lang.Object
- java.lang.Enum<HurricaneEnum>
- - org.ka2ddo.aprs.HurricaneEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HurricaneEnum>, EnumWithImageName, EnumWithUnits
```
public enum HurricaneEnum
extends java.lang.Enum<HurricaneEnum>
implements EnumWithImageName, EnumWithUnits
```
Symbolic codes for different types of hurricane/tropical storm information. The letter codes correspond to the hurricane comments in APRS position reports, as defined in the APRS protocol specification, chapter 12.

Author:

Andrew Pavlin, KA2DDO

See Also:

PositionReport

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HurricaneEnum.StormType
Values allowed for type of storm in a hurricane position report.

Nested Classes
Modifier and Type	Class and Description
`static class`	`HurricaneEnum.StormType` Values allowed for type of storm in a hurricane position report.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`GUST` Peak gust speed of wind in storm in knots (nm/hr).
`PRESSURE` Barometric pressure at center of storm in hectoPascals (millibars).
`RADIUS_GALE` Radius of gale-force winds in nautical miles.
`RADIUS_HURRICANE` Radius of hurricane winds in nautical miles.
`RADIUS_TROP_STORM` Radius of tropical-storm-level winds in nautical miles.
`STORM_TYPE` Type of severe storm.
`SUSTAINED_WIND` Sustained windspeed of storm in knots (nm/hr).

Field Summary

Fields
Modifier and Type Field and Description

int paramLen
Number of characters for parameter identified by this enum.

Fields
Modifier and Type	Field and Description
`int`	`paramLen` Number of characters for parameter identified by this enum.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HurricaneEnum`	`getEnumForLetter(char ch)` Get the enumeration associated with the hurricane message letter code.
`java.lang.String`	`getImagePath()` Return the relative path name of the image file for this enum value.
`java.lang.Enum<?>`	`getUnit()` Get the unit (if any) for values for this WeatherEnum,
`float`	`getUnitScaling()` Get the scaling factor to apply to the unit for values for this WeatherEnum.
`boolean`	`isUnitARate()` Indicate whether values and units should be interpreted as a rate over an appropriate time unit rather than a fixed quantity.
`static HurricaneEnum[]`	`nonClonedValues()` Returns a single copy of the list of WeatherEnums.
`static HurricaneEnum`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static HurricaneEnum[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STORM_TYPE
```
public static final HurricaneEnum STORM_TYPE
```
    Type of severe storm.
    
    See Also:
    
    HurricaneEnum.StormType
  - SUSTAINED_WIND
```
public static final HurricaneEnum SUSTAINED_WIND
```
    Sustained windspeed of storm in knots (nm/hr).
    
    See Also:
    
    DistanceUnit.NM
  - GUST
```
public static final HurricaneEnum GUST
```
    Peak gust speed of wind in storm in knots (nm/hr).
    
    See Also:
    
    DistanceUnit.NM
  - PRESSURE
```
public static final HurricaneEnum PRESSURE
```
    Barometric pressure at center of storm in hectoPascals (millibars).
    
    See Also:
    
    PressureUnit.HPa
  - RADIUS_HURRICANE
```
public static final HurricaneEnum RADIUS_HURRICANE
```
    Radius of hurricane winds in nautical miles.
    
    See Also:
    
    DistanceUnit.NM
  - RADIUS_TROP_STORM
```
public static final HurricaneEnum RADIUS_TROP_STORM
```
    Radius of tropical-storm-level winds in nautical miles.
    
    See Also:
    
    DistanceUnit.NM
  - RADIUS_GALE
```
public static final HurricaneEnum RADIUS_GALE
```
    Radius of gale-force winds in nautical miles.
    
    See Also:
    
    DistanceUnit.NM
- Field Detail
  - paramLen
```
public final int paramLen
```
    Number of characters for parameter identified by this enum.
- Method Detail
  - values
```
public static HurricaneEnum[] 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 (HurricaneEnum c : HurricaneEnum.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HurricaneEnum 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
  - getImagePath
```
public java.lang.String getImagePath()
```
    Return the relative path name of the image file for this enum value.
    
    Specified by:
    
    getImagePath in interface EnumWithImageName
    
    Returns:
    
    path name String, or a two-character APRS symbol table ID and code
  - getEnumForLetter
```
public static HurricaneEnum getEnumForLetter(char ch)
```
    Get the enumeration associated with the hurricane message letter code.
    
    Parameters:
    
    ch - letter to match against the known enums
    
    Returns:
    
    HurricaneEnum corresponding to the letter, or null if not matching any known hurricane parameter
  - getUnit
```
public java.lang.Enum<?> getUnit()
```
    Get the unit (if any) for values for this WeatherEnum,
    
    Specified by:
    
    getUnit in interface EnumWithUnits
    
    Returns:
    
    unit Enum, or null if no unit known
  - isUnitARate
```
public boolean isUnitARate()
```
    Indicate whether values and units should be interpreted as a rate over an appropriate time unit rather than a fixed quantity.
    
    Specified by:
    
    isUnitARate in interface EnumWithUnits
    
    Returns:
    
    boolean true if unit is a rate rather than a scalar
  - getUnitScaling
```
public float getUnitScaling()
```
    Get the scaling factor to apply to the unit for values for this WeatherEnum.
    
    Returns:
    
    float scale factor to apply to unit for displaying value, or Float.NaN if no unit
  - nonClonedValues
```
public static HurricaneEnum[] nonClonedValues()
```
    Returns a single copy of the list of WeatherEnums. Callers should ensure they do not modify the returned array, as this could have unpredictable consequences to other users of the array.
    
    Returns:
    
    array of defined WeatherEnum values in enumerated order

Enum HurricaneEnum

Nested Class Summary

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STORM_TYPE

SUSTAINED_WIND

GUST

PRESSURE

RADIUS_HURRICANE

RADIUS_TROP_STORM

RADIUS_GALE

Field Detail

paramLen

Method Detail

values

valueOf

getImagePath

getEnumForLetter

getUnit

isUnitARate

getUnitScaling

nonClonedValues