Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class NavigationServiceData

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

This data is related to what a navigation service would provide.

Fields

KEY_TIMESTAMP

public static final java.lang.String KEY_TIMESTAMP
Constant Value
"timeStamp"

KEY_ORIGIN

public static final java.lang.String KEY_ORIGIN
Constant Value
"origin"

KEY_DESTINATION

public static final java.lang.String KEY_DESTINATION
Constant Value
"destination"

KEY_DESTINATION_ETA

public static final java.lang.String KEY_DESTINATION_ETA
Constant Value
"destinationETA"

KEY_INSTRUCTIONS

public static final java.lang.String KEY_INSTRUCTIONS
Constant Value
"instructions"

KEY_NEXT_INSTRUCTION_ETA

public static final java.lang.String KEY_NEXT_INSTRUCTION_ETA
Constant Value
"nextInstructionETA"

KEY_NEXT_INSTRUCTION_DISTANCE

public static final java.lang.String KEY_NEXT_INSTRUCTION_DISTANCE
Constant Value
"nextInstructionDistance"

KEY_NEXT_INSTRUCTION_DISTANCE_SCALE

public static final java.lang.String KEY_NEXT_INSTRUCTION_DISTANCE_SCALE
Constant Value
"nextInstructionDistanceScale"

KEY_PROMPT

public static final java.lang.String KEY_PROMPT
Constant Value
"prompt"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

NavigationServiceData()

public NavigationServiceData()

NavigationServiceData( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public NavigationServiceData(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash

NavigationServiceData( DateTime timeStamp )

public NavigationServiceData(DateTime timeStamp)

Parameters

timeStamp

Methods

setTimeStamp( DateTime timeStamp )

This is the timeStamp of when the data was generated. This is to ensure any time or distance given in the data can accurately be adjusted if necessary.

public void setTimeStamp(DateTime timeStamp)

Parameters

timeStamp
-

getTimeStamp()

This is the timeStamp of when the data was generated. This is to ensure any time or distance given in the data can accurately be adjusted if necessary.

public com.smartdevicelink.proxy.rpc.DateTime getTimeStamp()

setOrigin( LocationDetails origin )

public void setOrigin(LocationDetails origin)

Parameters

origin
-

getOrigin()

public com.smartdevicelink.proxy.rpc.LocationDetails getOrigin()

setDestination( LocationDetails destination )

public void setDestination(LocationDetails destination)

Parameters

destination
-

getDestination()

public com.smartdevicelink.proxy.rpc.LocationDetails getDestination()

setDestinationETA( DateTime destinationETA )

public void setDestinationETA(DateTime destinationETA)

Parameters

destinationETA
-

getDestinationETA()

public com.smartdevicelink.proxy.rpc.DateTime getDestinationETA()

setInstructions( java.util.List<com.smartdevicelink.proxy.rpc.NavigationInstruction> instructions )

This array should be ordered with all remaining instructions. The start of this array should always contain the next instruction.

public void setInstructions(java.util.List<com.smartdevicelink.proxy.rpc.NavigationInstruction> instructions)

Parameters

instructions
-

getInstructions()

This array should be ordered with all remaining instructions. The start of this array should always contain the next instruction.

public java.util.List getInstructions()

setNextInstructionETA( DateTime nextInstructionETA )

public void setNextInstructionETA(DateTime nextInstructionETA)

Parameters

nextInstructionETA
-

getNextInstructionETA()

public com.smartdevicelink.proxy.rpc.DateTime getNextInstructionETA()

setNextInstructionDistance( Float nextInstructionDistance )

The distance to this instruction from current location. This should only be updated every .1 unit of distance. For more accuracy the consumer can use the GPS location of itself and the next instruction.

public void setNextInstructionDistance(Float nextInstructionDistance)

Parameters

nextInstructionDistance
-

getNextInstructionDistance()

The distance to this instruction from current location. This should only be updated every .1 unit of distance. For more accuracy the consumer can use the GPS location of itself and the next instruction.

public java.lang.Float getNextInstructionDistance()

setNextInstructionDistanceScale( Float nextInstructionDistanceScale )

Distance till next maneuver (starting from) from previous maneuver.

public void setNextInstructionDistanceScale(Float nextInstructionDistanceScale)

Parameters

nextInstructionDistanceScale
-

getNextInstructionDistanceScale()

Distance till next maneuver (starting from) from previous maneuver.

public java.lang.Float getNextInstructionDistanceScale()

setPrompt( String prompt )

This is a prompt message that should be conveyed to the user through either display or voice (TTS). This param will change often as it should represent the following: approaching instruction, post instruction, alerts that affect the current navigation session, etc.

public void setPrompt(String prompt)

Parameters

prompt
-

getPrompt()

This is a prompt message that should be conveyed to the user through either display or voice (TTS). This param will change often as it should represent the following: approaching instruction, post instruction, alerts that affect the current navigation session, etc.

public java.lang.String getPrompt()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section