com.smartdevicelink.proxy.rpc

Class NavigationInstruction

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.NavigationInstruction

All Implemented Interfaces:

Cloneable

public class NavigationInstruction
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ACTION
static String	KEY_BEARING
static String	KEY_DETAILS
static String	KEY_DRIVING_SIDE
static String	KEY_ETA
static String	KEY_IMAGE
static String	KEY_JUNCTION_TYPE
static String	KEY_LOCATION_DETAILS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
NavigationInstruction()
NavigationInstruction(Hashtable<String,Object> hash)
NavigationInstruction(LocationDetails locationDetails, NavigationAction action)

Method Summary

Modifier and Type	Method and Description
NavigationAction	getAction()
Integer	getBearing() The angle at which this instruction takes place.
String	getDetails() This is a string representation of this instruction, used to display instructions to the users.
Direction	getDrivingSide() Used to infer which side of the road this instruction takes place.
DateTime	getEta()
Image	getImage() An image representation of this instruction.
NavigationJunction	getJunctionType()
LocationDetails	getLocationDetails()
NavigationInstruction	setAction(NavigationAction action)
NavigationInstruction	setBearing(Integer bearing) The angle at which this instruction takes place.
NavigationInstruction	setDetails(String details) This is a string representation of this instruction, used to display instructions to the users.
NavigationInstruction	setDrivingSide(Direction drivingSide) Used to infer which side of the road this instruction takes place.
NavigationInstruction	setEta(DateTime eta)
NavigationInstruction	setImage(Image image) An image representation of this instruction.
NavigationInstruction	setJunctionType(NavigationJunction junctionType)
NavigationInstruction	setLocationDetails(LocationDetails locationDetails)

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_LOCATION_DETAILS

public static final String KEY_LOCATION_DETAILS

See Also:

Constant Field Values

KEY_ACTION

public static final String KEY_ACTION

See Also:

Constant Field Values

KEY_ETA

public static final String KEY_ETA

See Also:

Constant Field Values

KEY_BEARING

public static final String KEY_BEARING

See Also:

Constant Field Values

KEY_JUNCTION_TYPE

public static final String KEY_JUNCTION_TYPE

See Also:

Constant Field Values

KEY_DRIVING_SIDE

public static final String KEY_DRIVING_SIDE

See Also:

Constant Field Values

KEY_DETAILS

public static final String KEY_DETAILS

See Also:

Constant Field Values

KEY_IMAGE

public static final String KEY_IMAGE

See Also:

Constant Field Values

Constructor Detail

NavigationInstruction

public NavigationInstruction()

NavigationInstruction

public NavigationInstruction(Hashtable<String,Object> hash)

NavigationInstruction

public NavigationInstruction(@NonNull
                             LocationDetails locationDetails,
                             @NonNull
                             NavigationAction action)

Method Detail

setLocationDetails

public NavigationInstruction setLocationDetails(@NonNull
                                                LocationDetails locationDetails)

Parameters:

locationDetails - -

getLocationDetails

public LocationDetails getLocationDetails()

Returns:

locationDetails

setAction

public NavigationInstruction setAction(@NonNull
                                       NavigationAction action)

Parameters:

action - -

getAction

public NavigationAction getAction()

Returns:

action

setEta

public NavigationInstruction setEta(DateTime eta)

Parameters:

eta - -

getEta

public DateTime getEta()

Returns:

eta

setBearing

public NavigationInstruction setBearing(Integer bearing)

The angle at which this instruction takes place. For example, 0 would mean straight, <=45 is bearing right, >= 135 is sharp right, between 45 and 135 is a regular right, and 180 is a U-Turn, etc.

Parameters:

bearing - - minValue="0" maxValue="359"

getBearing

public Integer getBearing()

The angle at which this instruction takes place. For example, 0 would mean straight, <=45 is bearing right, >= 135 is sharp right, between 45 and 135 is a regular right, and 180 is a U-Turn, etc.

Returns:

bearing - minValue="0" maxValue="359"

setJunctionType

public NavigationInstruction setJunctionType(NavigationJunction junctionType)

Parameters:

junctionType - -

getJunctionType

public NavigationJunction getJunctionType()

Returns:

junctionType

setDrivingSide

public NavigationInstruction setDrivingSide(Direction drivingSide)

Used to infer which side of the road this instruction takes place. For a U-Turn (action=TURN, bearing=180) this will determine which direction the turn should take place.

Parameters:

drivingSide - - Direction enum value that represents the driving side

getDrivingSide

public Direction getDrivingSide()

Used to infer which side of the road this instruction takes place. For a U-Turn (action=TURN, bearing=180) this will determine which direction the turn should take place.

Returns:

drivingSide

setDetails

public NavigationInstruction setDetails(String details)

This is a string representation of this instruction, used to display instructions to the users. This is not intended to be read aloud to the users, see the param prompt in NavigationServiceData for that.

Parameters:

details - -

getDetails

public String getDetails()

This is a string representation of this instruction, used to display instructions to the users. This is not intended to be read aloud to the users, see the param prompt in NavigationServiceData for that.

Returns:

details

setImage

public NavigationInstruction setImage(Image image)

An image representation of this instruction.

Parameters:

image - -

getImage

public Image getImage()

An image representation of this instruction.

Returns:

image