Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaSE Documentation
NavigationInstruction

Class NavigationInstruction

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Fields

KEY_LOCATION_DETAILS

public static final java.lang.String KEY_LOCATION_DETAILS
Constant Value
"locationDetails"

KEY_ACTION

public static final java.lang.String KEY_ACTION
Constant Value
"action"

KEY_ETA

public static final java.lang.String KEY_ETA
Constant Value
"eta"

KEY_BEARING

public static final java.lang.String KEY_BEARING
Constant Value
"bearing"

KEY_JUNCTION_TYPE

public static final java.lang.String KEY_JUNCTION_TYPE
Constant Value
"junctionType"

KEY_DRIVING_SIDE

public static final java.lang.String KEY_DRIVING_SIDE
Constant Value
"drivingSide"

KEY_DETAILS

public static final java.lang.String KEY_DETAILS
Constant Value
"details"

KEY_IMAGE

public static final java.lang.String KEY_IMAGE
Constant Value
"image"

Inherited Fields

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

Constructors

public NavigationInstruction()

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

Constructor Parameters

hash

public NavigationInstruction(LocationDetails locationDetails,NavigationAction action)

Constructor Parameters

locationDetails
action

Methods

setLocationDetails( LocationDetails locationDetails )

public com.smartdevicelink.proxy.rpc.NavigationInstruction setLocationDetails(LocationDetails locationDetails)

Method Parameters

locationDetails
-

getLocationDetails()

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

setAction( NavigationAction action )

public com.smartdevicelink.proxy.rpc.NavigationInstruction setAction(NavigationAction action)

Method Parameters

action
-

getAction()

public com.smartdevicelink.proxy.rpc.enums.NavigationAction getAction()

setEta( DateTime eta )

public com.smartdevicelink.proxy.rpc.NavigationInstruction setEta(DateTime eta)

Method Parameters

eta
-

getEta()

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

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.

public com.smartdevicelink.proxy.rpc.NavigationInstruction setBearing(Integer bearing)

Method Parameters

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

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.

public java.lang.Integer getBearing()

setJunctionType( NavigationJunction junctionType )

public com.smartdevicelink.proxy.rpc.NavigationInstruction setJunctionType(NavigationJunction junctionType)

Method Parameters

junctionType
-

getJunctionType()

public com.smartdevicelink.proxy.rpc.enums.NavigationJunction getJunctionType()

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.

public com.smartdevicelink.proxy.rpc.NavigationInstruction setDrivingSide(Direction drivingSide)

Method Parameters

drivingSide
- Direction enum value that represents the driving side

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.

public com.smartdevicelink.proxy.rpc.enums.Direction getDrivingSide()

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.

public com.smartdevicelink.proxy.rpc.NavigationInstruction setDetails(String details)

Method Parameters

details
-

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.

public java.lang.String getDetails()

setImage( Image image )

An image representation of this instruction.

public com.smartdevicelink.proxy.rpc.NavigationInstruction setImage(Image image)

Method Parameters

image
-

getImage()

An image representation of this instruction.

public com.smartdevicelink.proxy.rpc.Image getImage()

Inherited Methods

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