com.smartdevicelink.proxy.rpc

Class NavigationServiceData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.NavigationServiceData

All Implemented Interfaces:

Cloneable

public class NavigationServiceData
extends RPCStruct

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DESTINATION
static String	KEY_DESTINATION_ETA
static String	KEY_INSTRUCTIONS
static String	KEY_NEXT_INSTRUCTION_DISTANCE
static String	KEY_NEXT_INSTRUCTION_DISTANCE_SCALE
static String	KEY_NEXT_INSTRUCTION_ETA
static String	KEY_ORIGIN
static String	KEY_PROMPT
static String	KEY_TIMESTAMP

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
NavigationServiceData()
NavigationServiceData(DateTime timeStamp)
NavigationServiceData(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
LocationDetails	getDestination()
DateTime	getDestinationETA()
List<NavigationInstruction>	getInstructions() This array should be ordered with all remaining instructions.
Float	getNextInstructionDistance() The distance to this instruction from current location.
Float	getNextInstructionDistanceScale() Distance till next maneuver (starting from) from previous maneuver.
DateTime	getNextInstructionETA()
LocationDetails	getOrigin()
String	getPrompt() This is a prompt message that should be conveyed to the user through either display or voice (TTS).
DateTime	getTimeStamp() This is the timeStamp of when the data was generated.
NavigationServiceData	setDestination(LocationDetails destination)
NavigationServiceData	setDestinationETA(DateTime destinationETA)
NavigationServiceData	setInstructions(List<NavigationInstruction> instructions) This array should be ordered with all remaining instructions.
NavigationServiceData	setNextInstructionDistance(Float nextInstructionDistance) The distance to this instruction from current location.
NavigationServiceData	setNextInstructionDistanceScale(Float nextInstructionDistanceScale) Distance till next maneuver (starting from) from previous maneuver.
NavigationServiceData	setNextInstructionETA(DateTime nextInstructionETA)
NavigationServiceData	setOrigin(LocationDetails origin)
NavigationServiceData	setPrompt(String prompt) This is a prompt message that should be conveyed to the user through either display or voice (TTS).
NavigationServiceData	setTimeStamp(DateTime timeStamp) This is the timeStamp of when the data was generated.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_TIMESTAMP

public static final String KEY_TIMESTAMP

See Also:

Constant Field Values

KEY_ORIGIN

public static final String KEY_ORIGIN

See Also:

Constant Field Values

KEY_DESTINATION

public static final String KEY_DESTINATION

See Also:

Constant Field Values

KEY_DESTINATION_ETA

public static final String KEY_DESTINATION_ETA

See Also:

Constant Field Values

KEY_INSTRUCTIONS

public static final String KEY_INSTRUCTIONS

See Also:

Constant Field Values

KEY_NEXT_INSTRUCTION_ETA

public static final String KEY_NEXT_INSTRUCTION_ETA

See Also:

Constant Field Values

KEY_NEXT_INSTRUCTION_DISTANCE

public static final String KEY_NEXT_INSTRUCTION_DISTANCE

See Also:

Constant Field Values

KEY_NEXT_INSTRUCTION_DISTANCE_SCALE

public static final String KEY_NEXT_INSTRUCTION_DISTANCE_SCALE

See Also:

Constant Field Values

KEY_PROMPT

public static final String KEY_PROMPT

See Also:

Constant Field Values

Constructor Detail

NavigationServiceData

public NavigationServiceData()

NavigationServiceData

public NavigationServiceData(Hashtable<String,Object> hash)

NavigationServiceData

public NavigationServiceData(@NonNull
                             DateTime timeStamp)

Method Detail

setTimeStamp

public NavigationServiceData setTimeStamp(@NonNull
                                          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.

Parameters:

timeStamp - -

getTimeStamp

public DateTime 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.

Returns:

timeStamp

setOrigin

public NavigationServiceData setOrigin(LocationDetails origin)

Parameters:

origin - -

getOrigin

public LocationDetails getOrigin()

Returns:

origin

setDestination

public NavigationServiceData setDestination(LocationDetails destination)

Parameters:

destination - -

getDestination

public LocationDetails getDestination()

Returns:

destination

setDestinationETA

public NavigationServiceData setDestinationETA(DateTime destinationETA)

Parameters:

destinationETA - -

getDestinationETA

public DateTime getDestinationETA()

Returns:

destinationETA

setInstructions

public NavigationServiceData setInstructions(List<NavigationInstruction> instructions)

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

Parameters:

instructions - -

getInstructions

public List<NavigationInstruction> getInstructions()

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

Returns:

instructions

setNextInstructionETA

public NavigationServiceData setNextInstructionETA(DateTime nextInstructionETA)

Parameters:

nextInstructionETA - -

getNextInstructionETA

public DateTime getNextInstructionETA()

Returns:

nextInstructionETA

setNextInstructionDistance

public NavigationServiceData 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.

Parameters:

nextInstructionDistance - -

getNextInstructionDistance

public Float 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.

Returns:

nextInstructionDistance

setNextInstructionDistanceScale

public NavigationServiceData setNextInstructionDistanceScale(Float nextInstructionDistanceScale)

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

Parameters:

nextInstructionDistanceScale - -

getNextInstructionDistanceScale

public Float getNextInstructionDistanceScale()

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

Returns:

nextInstructionDistanceScale

setPrompt

public NavigationServiceData 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.

Parameters:

prompt - -

getPrompt

public String 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.

Returns:

prompt