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
Documentation
GPSData

Class GPSData

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

Describes the GPS data. Not all data will be available on all car lines.

Parameter List

Name Type Description SmartDeviceLink Ver. Available
longitudeDegrees Double Minvalue: - 180 Maxvalue: 180 SmartDeviceLink 2.0
latitudeDegrees Double Minvalue: - 90Maxvalue: 90 SmartDeviceLink 2.0
utcYear Integer Minvalue: 2010Maxvalue: 2100 SmartDeviceLink 2.0
utcMonth Integer Minvalue: 1Maxvalue: 12 SmartDeviceLink 2.0
utcDay Integer Minvalue: 1Maxvalue: 31 SmartDeviceLink 2.0
utcHours Integer Minvalue: 0Maxvalue: 23 SmartDeviceLink 2.0
utcMinutes Integer Minvalue: 0Maxvalue: 59 SmartDeviceLink 2.0
utcSeconds Integer Minvalue: 0Maxvalue: 59 SmartDeviceLink 2.0
pdop Integer Positional Dilution of Precision. If undefined or unavailable, then value shall be set to 0.Minvalue: 0Maxvalue: 1000 SmartDeviceLink 2.0
hdop Integer Horizontal Dilution of Precision. If value is unknown, value shall be set to 0.Minvalue: 0Maxvalue: 1000 SmartDeviceLink 2.0
vdop Integer Vertical Dilution of Precision. If value is unknown, value shall be set to 0.Minvalue: 0Maxvalue: 1000 SmartDeviceLink 2.0
actual Boolean True, if coordinates are based on satellites. False, if based on dead reckoning SmartDeviceLink 2.0
satellites Integer Number of satellites in view Minvalue: 0 Maxvalue: 31 SmartDeviceLink 2.0
altitude Integer Altitude in meters Minvalue: -10000 Maxvalue: 10000 Note: SYNC uses Mean Sea Level for calculating GPS. SmartDeviceLink 2.0
heading Double The heading. North is 0, East is 90, etc. Minvalue: 0 Maxvalue: 359.99 Resolution is 0.01 SmartDeviceLink 2.0
speed Integer The speed in KPH Minvalue: 0 Maxvalue: 500 SmartDeviceLink 2.0

Fields

KEY_LONGITUDE_DEGREES

public static final java.lang.String KEY_LONGITUDE_DEGREES
Constant Value
"longitudeDegrees"

KEY_LATITUDE_DEGREES

public static final java.lang.String KEY_LATITUDE_DEGREES
Constant Value
"latitudeDegrees"

KEY_UTC_YEAR

public static final java.lang.String KEY_UTC_YEAR
Constant Value
"utcYear"

KEY_UTC_MONTH

public static final java.lang.String KEY_UTC_MONTH
Constant Value
"utcMonth"

KEY_UTC_DAY

public static final java.lang.String KEY_UTC_DAY
Constant Value
"utcDay"

KEY_UTC_HOURS

public static final java.lang.String KEY_UTC_HOURS
Constant Value
"utcHours"

KEY_UTC_MINUTES

public static final java.lang.String KEY_UTC_MINUTES
Constant Value
"utcMinutes"

KEY_UTC_SECONDS

public static final java.lang.String KEY_UTC_SECONDS
Constant Value
"utcSeconds"

KEY_COMPASS_DIRECTION

public static final java.lang.String KEY_COMPASS_DIRECTION
Constant Value
"compassDirection"

KEY_PDOP

public static final java.lang.String KEY_PDOP
Constant Value
"pdop"

KEY_VDOP

public static final java.lang.String KEY_VDOP
Constant Value
"vdop"

KEY_HDOP

public static final java.lang.String KEY_HDOP
Constant Value
"hdop"

KEY_ACTUAL

public static final java.lang.String KEY_ACTUAL
Constant Value
"actual"

KEY_SATELLITES

public static final java.lang.String KEY_SATELLITES
Constant Value
"satellites"

KEY_DIMENSION

public static final java.lang.String KEY_DIMENSION
Constant Value
"dimension"

KEY_ALTITUDE

public static final java.lang.String KEY_ALTITUDE
Constant Value
"altitude"

KEY_HEADING

public static final java.lang.String KEY_HEADING
Constant Value
"heading"

KEY_SPEED

public static final java.lang.String KEY_SPEED
Constant Value
"speed"

KEY_SHIFTED

public static final java.lang.String KEY_SHIFTED
Constant Value
"shifted"

Inherited Fields

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

Constructors

GPSData()

Constructs a newly allocated GPSData object

public GPSData()

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

Constructs a newly allocated GPSData object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

GPSData( Double longitudeDegrees, Double latitudeDegrees )

Constructs a newly allocated GPSData object

public GPSData(Double longitudeDegrees,Double latitudeDegrees)

Parameters

longitudeDegrees
latitudeDegrees

Methods

setLongitudeDegrees( Double longitudeDegrees )

set longitude degrees

public com.smartdevicelink.proxy.rpc.GPSData setLongitudeDegrees(Double longitudeDegrees)

Parameters

longitudeDegrees
degrees of the longitudinal position

getLongitudeDegrees()

get longitude degrees

public java.lang.Double getLongitudeDegrees()

setLatitudeDegrees( Double latitudeDegrees )

set latitude degrees

public com.smartdevicelink.proxy.rpc.GPSData setLatitudeDegrees(Double latitudeDegrees)

Parameters

latitudeDegrees
degrees of the latitudinal position

getLatitudeDegrees()

get latitude degrees

public java.lang.Double getLatitudeDegrees()

setUtcYear( Integer utcYear )

set utc year

public com.smartdevicelink.proxy.rpc.GPSData setUtcYear(Integer utcYear)

Parameters

utcYear
utc year

getUtcYear()

get utc year

public java.lang.Integer getUtcYear()

setUtcMonth( Integer utcMonth )

set utc month

public com.smartdevicelink.proxy.rpc.GPSData setUtcMonth(Integer utcMonth)

Parameters

utcMonth
utc month

getUtcMonth()

get utc month

public java.lang.Integer getUtcMonth()

setUtcDay( Integer utcDay )

set utc day

public com.smartdevicelink.proxy.rpc.GPSData setUtcDay(Integer utcDay)

Parameters

utcDay
utc day

getUtcDay()

get utc day

public java.lang.Integer getUtcDay()

setUtcHours( Integer utcHours )

set utc hours

public com.smartdevicelink.proxy.rpc.GPSData setUtcHours(Integer utcHours)

Parameters

utcHours
utc hours

getUtcHours()

get utc hours

public java.lang.Integer getUtcHours()

setUtcMinutes( Integer utcMinutes )

set utc minutes

public com.smartdevicelink.proxy.rpc.GPSData setUtcMinutes(Integer utcMinutes)

Parameters

utcMinutes
utc minutes

getUtcMinutes()

get utc minutes

public java.lang.Integer getUtcMinutes()

setUtcSeconds( Integer utcSeconds )

set utc seconds

public com.smartdevicelink.proxy.rpc.GPSData setUtcSeconds(Integer utcSeconds)

Parameters

utcSeconds
utc seconds

getUtcSeconds()

get utc seconds

public java.lang.Integer getUtcSeconds()

setCompassDirection( CompassDirection compassDirection )

public com.smartdevicelink.proxy.rpc.GPSData setCompassDirection(CompassDirection compassDirection)

Parameters

compassDirection

getCompassDirection()

public com.smartdevicelink.proxy.rpc.enums.CompassDirection getCompassDirection()

setPdop( Double pdop )

set the positional dilution of precision

public com.smartdevicelink.proxy.rpc.GPSData setPdop(Double pdop)

Parameters

pdop
the positional dilution of precision

getPdop()

get the positional dilution of precision

public java.lang.Double getPdop()

setHdop( Double hdop )

set the horizontal dilution of precision

public com.smartdevicelink.proxy.rpc.GPSData setHdop(Double hdop)

Parameters

hdop
the horizontal dilution of precision

getHdop()

get the horizontal dilution of precision

public java.lang.Double getHdop()

setVdop( Double vdop )

set the vertical dilution of precision

public com.smartdevicelink.proxy.rpc.GPSData setVdop(Double vdop)

Parameters

vdop
the vertical dilution of precision

getVdop()

get the vertical dilution of precision

public java.lang.Double getVdop()

setActual( Boolean actual )

set what coordinates based on

public com.smartdevicelink.proxy.rpc.GPSData setActual(Boolean actual)

Parameters

actual
True, if coordinates are based on satellites.False, if based on dead reckoning

getActual()

get what coordinates based on

public java.lang.Boolean getActual()

setSatellites( Integer satellites )

set the number of satellites in view

public com.smartdevicelink.proxy.rpc.GPSData setSatellites(Integer satellites)

Parameters

satellites
the number of satellites in view

getSatellites()

get the number of satellites in view

public java.lang.Integer getSatellites()

setDimension( Dimension dimension )

public com.smartdevicelink.proxy.rpc.GPSData setDimension(Dimension dimension)

Parameters

dimension

getDimension()

public com.smartdevicelink.proxy.rpc.enums.Dimension getDimension()

setAltitude( Double altitude )

set altitude in meters

public com.smartdevicelink.proxy.rpc.GPSData setAltitude(Double altitude)

Parameters

altitude
altitude in meters

getAltitude()

get altitude in meters

public java.lang.Double getAltitude()

setHeading( Double heading )

set the heading.North is 0, East is 90, etc.

public com.smartdevicelink.proxy.rpc.GPSData setHeading(Double heading)

Parameters

heading
the heading.

getHeading()

get the heading

public java.lang.Double getHeading()

setSpeed( Double speed )

set speed in KPH

public com.smartdevicelink.proxy.rpc.GPSData setSpeed(Double speed)

Parameters

speed
the speed

getSpeed()

get the speed in KPH

public java.lang.Double getSpeed()

setShifted( Boolean shifted )

Sets the shifted param for GPSData.

public com.smartdevicelink.proxy.rpc.GPSData setShifted(Boolean shifted)

Parameters

shifted
True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift). False, if the GPS data is raw and un-shifted. If not provided, then value is assumed False.

getShifted()

Gets the shifted param for GPSData.

public java.lang.Boolean getShifted()

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
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section