com.atakmap.android.routes.nav

Class NavigationCue

java.lang.Object

com.atakmap.android.routes.nav.NavigationCue

public class NavigationCue
extends java.lang.Object

Class representing a navigational cue along a route.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavigationCue.ConditionalNavigationCue Class representing the guts of a Navigation Cue.
static class	NavigationCue.TriggerMode Defines how the cue should be triggered--based on distance away from a point or estimated time until the point is reached.

Constructor Summary

Constructors

Constructor and Description
NavigationCue(java.lang.String id, java.lang.String voiceCue, java.lang.String textCue) Constructs a new Navigation Cue.

Method Summary

Modifier and Type	Method and Description
void	addCue(NavigationCue.TriggerMode triggerMode, int triggerValue) Adds a cue to the NavigationCue.
java.util.List<NavigationCue.ConditionalNavigationCue>	getCues() Gets a copy of the map associating departure UIDs to ConditionalNav cues.
java.lang.String	getID() Get the id of the waypoint that is associated with this Navigation Cue
java.lang.String	getTextCue() Gets the text cue associated with this cue.
java.lang.String	getVoiceCue() Gets the voice cue associated with this cue.
static NavigationCue	inverseCue(java.lang.String newCueId, NavigationCue cue) Creates a new cue that is the inverse of the one that is passed as a parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavigationCue

public NavigationCue(java.lang.String id,
                     java.lang.String voiceCue,
                     java.lang.String textCue)

Constructs a new Navigation Cue.

Parameters:

id - the id for the navigation cue

voiceCue - the voice cue to be spoken

textCue - the text cue to be displayed

Method Detail

addCue

public void addCue(NavigationCue.TriggerMode triggerMode,
                   int triggerValue)

Adds a cue to the NavigationCue.

Parameters:

triggerMode - distance or time

triggerValue - the trigger value related to the mode

getID

public java.lang.String getID()

Get the id of the waypoint that is associated with this Navigation Cue

getVoiceCue

public java.lang.String getVoiceCue()

Gets the voice cue associated with this cue.

Returns:

return the voice cue

getTextCue

public java.lang.String getTextCue()

Gets the text cue associated with this cue.

Returns:

returns the text cue

getCues

public java.util.List<NavigationCue.ConditionalNavigationCue> getCues()

Gets a copy of the map associating departure UIDs to ConditionalNav cues.

Returns:

get all cues

inverseCue

public static NavigationCue inverseCue(java.lang.String newCueId,
                                       NavigationCue cue)

Creates a new cue that is the inverse of the one that is passed as a parameter. Conditional cues from the source cue will be preserved for the new cue.

Parameters:

newCueId - The ID that new cue should have

cue - The cue to create the inverse of

Returns:

the navigation cue reversed.