com.atakmap.android.routes.nav

Enum NavigationCue.TriggerMode

java.lang.Object

java.lang.Enum<NavigationCue.TriggerMode>

com.atakmap.android.routes.nav.NavigationCue.TriggerMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NavigationCue.TriggerMode>

Enclosing class:

NavigationCue

public static enum NavigationCue.TriggerMode
extends java.lang.Enum<NavigationCue.TriggerMode>

Defines how the cue should be triggered--based on distance away from a point or estimated time until the point is reached. For now, only distance is supported.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTANCE
ETA

Method Summary

Modifier and Type	Method and Description
static NavigationCue.TriggerMode	fromValue(java.lang.Character val) Decodes the TriggerMode from its encoding as a character.
java.lang.Character	toValue() Encodes the Trigger Mode as a character.
static NavigationCue.TriggerMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NavigationCue.TriggerMode[]	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

DISTANCE

public static final NavigationCue.TriggerMode DISTANCE

ETA

public static final NavigationCue.TriggerMode ETA

Method Detail

values

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

Returns:

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

valueOf

public static NavigationCue.TriggerMode 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

toValue

public java.lang.Character toValue()

Encodes the Trigger Mode as a character.

Returns:

Character representing the trigger mode

fromValue

public static NavigationCue.TriggerMode fromValue(java.lang.Character val)

Decodes the TriggerMode from its encoding as a character.

Parameters:

val - the encoded character

Returns:

the corresponding trigger mode