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

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 carlines.

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

Quick Jump

Fields
Constructors
Methods

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"

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, Integer utcYear, Integer utcMonth, Integer utcDay, Integer utcHours, Integer utcMinutes, Integer utcSeconds, CompassDirection compassDirection, Double pdop, Double hdop, Double vdop, Boolean actual, Integer satellites, Dimension dimension, Double altitude, Double heading, Double speed )

Constructs a newly allocated GPSData object

public GPSData(Double longitudeDegrees,Double latitudeDegrees,Integer utcYear,Integer utcMonth,Integer utcDay,Integer utcHours,Integer utcMinutes,Integer utcSeconds,CompassDirection compassDirection,Double pdop,Double hdop,Double vdop,Boolean actual,Integer satellites,Dimension dimension,Double altitude,Double heading,Double speed)

Parameters

longitudeDegrees
latitudeDegrees
utcYear
utcMonth
utcDay
utcHours
utcMinutes
utcSeconds
compassDirection
pdop
hdop
vdop
actual
satellites
dimension
altitude
heading
speed

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 void setLongitudeDegrees(Double longitudeDegrees)

Parameters

longitudeDegrees

getLongitudeDegrees()

get longitude degrees

public java.lang.Double getLongitudeDegrees()

setLatitudeDegrees( Double latitudeDegrees )

set latitude degrees

public void setLatitudeDegrees(Double latitudeDegrees)

Parameters

latitudeDegrees
latitude degrees

getLatitudeDegrees()

get latitude degrees

public java.lang.Double getLatitudeDegrees()

setUtcYear( Integer utcYear )

set utc year

public void setUtcYear(Integer utcYear)

Parameters

utcYear
utc year

getUtcYear()

get utc year

public java.lang.Integer getUtcYear()

setUtcMonth( Integer utcMonth )

set utc month

public void setUtcMonth(Integer utcMonth)

Parameters

utcMonth
utc month

getUtcMonth()

get utc month

public java.lang.Integer getUtcMonth()

setUtcDay( Integer utcDay )

set utc day

public void setUtcDay(Integer utcDay)

Parameters

utcDay
utc day

getUtcDay()

get utc day

public java.lang.Integer getUtcDay()

setUtcHours( Integer utcHours )

set utc hours

public void setUtcHours(Integer utcHours)

Parameters

utcHours
utc hours

getUtcHours()

get utc hours

public java.lang.Integer getUtcHours()

setUtcMinutes( Integer utcMinutes )

set utc minutes

public void setUtcMinutes(Integer utcMinutes)

Parameters

utcMinutes
utc minutes

getUtcMinutes()

get utc minutes

public java.lang.Integer getUtcMinutes()

setUtcSeconds( Integer utcSeconds )

set utc seconds

public void setUtcSeconds(Integer utcSeconds)

Parameters

utcSeconds
utc seconds

getUtcSeconds()

get utc seconds

public java.lang.Integer getUtcSeconds()

setCompassDirection( CompassDirection compassDirection )

public void setCompassDirection(CompassDirection compassDirection)

Parameters

compassDirection

getCompassDirection()

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

setPdop( Double pdop )

set the positional dilution of precision

public void 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 void 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 void 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 void 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 void 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 void setDimension(Dimension dimension)

Parameters

dimension

getDimension()

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

setAltitude( Double altitude )

set altitude in meters

public void 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 void setHeading(Double heading)

Parameters

heading
the heading.

getHeading()

get the heading

public java.lang.Double getHeading()

setSpeed( Double speed )

set speed in KPH

public void setSpeed(Double speed)

Parameters

speed
the speed

getSpeed()

get the speed in KPH

public java.lang.Double getSpeed()

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