com.atakmap.android.user

Enum TLECategory

java.lang.Object

java.lang.Enum<TLECategory>

com.atakmap.android.user.TLECategory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TLECategory>

public enum TLECategory
extends java.lang.Enum<TLECategory>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAT1
CAT2
CAT3
CAT4
CAT5
UNKNOWN

Method Summary

Modifier and Type	Method and Description
TLEAccuracy	getAccuracy(double ce)
static TLECategory	getCategory(double ce)
double	getCE(TLEAccuracy acc)
static java.lang.String	getCEString(GeoPoint gp) Given a GeoPoint, obtain the appropriate CE string that describes the category.
int	getColor() Returns the recommended color coding to be associated with the CAT value for display throughout the application.
double	getHigh()
double	getLow()
double	getMedium()
java.lang.String	getName()
int	getValue()
static TLECategory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TLECategory[]	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

CAT1

public static final TLECategory CAT1

CAT2

public static final TLECategory CAT2

CAT3

public static final TLECategory CAT3

CAT4

public static final TLECategory CAT4

CAT5

public static final TLECategory CAT5

UNKNOWN

public static final TLECategory UNKNOWN

Method Detail

values

public static TLECategory[] 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 (TLECategory c : TLECategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

getValue

public int getValue()

getHigh

public double getHigh()

getLow

public double getLow()

getMedium

public double getMedium()

getName

public java.lang.String getName()

getColor

public int getColor()

Returns the recommended color coding to be associated with the CAT value for display throughout the application. A value of Color.White indicates that there is no recommendation and the application should assume default text coloring.

Returns:

The recommended color coding to be associated with the CAT value or Color.White for default text color.

getCategory

public static TLECategory getCategory(double ce)

getAccuracy

public TLEAccuracy getAccuracy(double ce)

getCE

public double getCE(TLEAccuracy acc)

getCEString

public static java.lang.String getCEString(GeoPoint gp)

Given a GeoPoint, obtain the appropriate CE string that describes the category. If the category is unknown, the the string returned will be UNK.

Parameters:

gp - the geopoint to use to construct the formatted ce string.

Returns:

the formatted ce string, or UNK if unknown.