GPSData (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.GPSData

All Implemented Interfaces:: Cloneable

public class GPSData
extends RPCStruct

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

Since:: SmartDeviceLink 2.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ACTUAL`
`static String`	`KEY_ALTITUDE`
`static String`	`KEY_COMPASS_DIRECTION`
`static String`	`KEY_DIMENSION`
`static String`	`KEY_HDOP`
`static String`	`KEY_HEADING`
`static String`	`KEY_LATITUDE_DEGREES`
`static String`	`KEY_LONGITUDE_DEGREES`
`static String`	`KEY_PDOP`
`static String`	`KEY_SATELLITES`
`static String`	`KEY_SHIFTED`
`static String`	`KEY_SPEED`
`static String`	`KEY_UTC_DAY`
`static String`	`KEY_UTC_HOURS`
`static String`	`KEY_UTC_MINUTES`
`static String`	`KEY_UTC_MONTH`
`static String`	`KEY_UTC_SECONDS`
`static String`	`KEY_UTC_YEAR`
`static String`	`KEY_VDOP`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`GPSData()` Constructs a newly allocated GPSData object
`GPSData(Double longitudeDegrees, Double latitudeDegrees)` Constructs a newly allocated GPSData object
`GPSData(Hashtable<String,Object> hash)` Constructs a newly allocated GPSData object indicated by the Hashtable parameter

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getActual()` get what coordinates based on
`Double`	`getAltitude()` get altitude in meters
`CompassDirection`	`getCompassDirection()`
`Dimension`	`getDimension()`
`Double`	`getHdop()` get the horizontal dilution of precision
`Double`	`getHeading()` get the heading
`Double`	`getLatitudeDegrees()` get latitude degrees
`Double`	`getLongitudeDegrees()` get longitude degrees
`Double`	`getPdop()` get the positional dilution of precision
`Integer`	`getSatellites()` get the number of satellites in view
`Boolean`	`getShifted()` Gets the shifted param for GPSData.
`Double`	`getSpeed()` get the speed in KPH
`Integer`	`getUtcDay()` get utc day
`Integer`	`getUtcHours()` get utc hours
`Integer`	`getUtcMinutes()` get utc minutes
`Integer`	`getUtcMonth()` get utc month
`Integer`	`getUtcSeconds()` get utc seconds
`Integer`	`getUtcYear()` get utc year
`Double`	`getVdop()` get the vertical dilution of precision
`GPSData`	`setActual(Boolean actual)` set what coordinates based on
`GPSData`	`setAltitude(Double altitude)` set altitude in meters
`GPSData`	`setCompassDirection(CompassDirection compassDirection)`
`GPSData`	`setDimension(Dimension dimension)`
`GPSData`	`setHdop(Double hdop)` set the horizontal dilution of precision
`GPSData`	`setHeading(Double heading)` set the heading.North is 0, East is 90, etc.
`GPSData`	`setLatitudeDegrees(Double latitudeDegrees)` set latitude degrees
`GPSData`	`setLongitudeDegrees(Double longitudeDegrees)` set longitude degrees
`GPSData`	`setPdop(Double pdop)` set the positional dilution of precision
`GPSData`	`setSatellites(Integer satellites)` set the number of satellites in view
`GPSData`	`setShifted(Boolean shifted)` Sets the shifted param for GPSData.
`GPSData`	`setSpeed(Double speed)` set speed in KPH
`GPSData`	`setUtcDay(Integer utcDay)` set utc day
`GPSData`	`setUtcHours(Integer utcHours)` set utc hours
`GPSData`	`setUtcMinutes(Integer utcMinutes)` set utc minutes
`GPSData`	`setUtcMonth(Integer utcMonth)` set utc month
`GPSData`	`setUtcSeconds(Integer utcSeconds)` set utc seconds
`GPSData`	`setUtcYear(Integer utcYear)` set utc year
`GPSData`	`setVdop(Double vdop)` set the vertical dilution of precision

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_LONGITUDE_DEGREES
```
public static final String KEY_LONGITUDE_DEGREES
```
    See Also:
    
    Constant Field Values
  - KEY_LATITUDE_DEGREES
```
public static final String KEY_LATITUDE_DEGREES
```
    See Also:
    
    Constant Field Values
  - KEY_UTC_YEAR
```
public static final String KEY_UTC_YEAR
```
    See Also:
    
    Constant Field Values
  - KEY_UTC_MONTH
```
public static final String KEY_UTC_MONTH
```
    See Also:
    
    Constant Field Values
  - KEY_UTC_DAY
```
public static final String KEY_UTC_DAY
```
    See Also:
    
    Constant Field Values
  - KEY_UTC_HOURS
```
public static final String KEY_UTC_HOURS
```
    See Also:
    
    Constant Field Values
  - KEY_UTC_MINUTES
```
public static final String KEY_UTC_MINUTES
```
    See Also:
    
    Constant Field Values
  - KEY_UTC_SECONDS
```
public static final String KEY_UTC_SECONDS
```
    See Also:
    
    Constant Field Values
  - KEY_COMPASS_DIRECTION
```
public static final String KEY_COMPASS_DIRECTION
```
    See Also:
    
    Constant Field Values
  - KEY_PDOP
```
public static final String KEY_PDOP
```
    See Also:
    
    Constant Field Values
  - KEY_VDOP
```
public static final String KEY_VDOP
```
    See Also:
    
    Constant Field Values
  - KEY_HDOP
```
public static final String KEY_HDOP
```
    See Also:
    
    Constant Field Values
  - KEY_ACTUAL
```
public static final String KEY_ACTUAL
```
    See Also:
    
    Constant Field Values
  - KEY_SATELLITES
```
public static final String KEY_SATELLITES
```
    See Also:
    
    Constant Field Values
  - KEY_DIMENSION
```
public static final String KEY_DIMENSION
```
    See Also:
    
    Constant Field Values
  - KEY_ALTITUDE
```
public static final String KEY_ALTITUDE
```
    See Also:
    
    Constant Field Values
  - KEY_HEADING
```
public static final String KEY_HEADING
```
    See Also:
    
    Constant Field Values
  - KEY_SPEED
```
public static final String KEY_SPEED
```
    See Also:
    
    Constant Field Values
  - KEY_SHIFTED
```
public static final String KEY_SHIFTED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GPSData
```
public GPSData()
```
    Constructs a newly allocated GPSData object
  - GPSData
```
public GPSData(Hashtable<String,Object> hash)
```
    Constructs a newly allocated GPSData object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - GPSData
```
public GPSData(@NonNull
               Double longitudeDegrees,
               @NonNull
               Double latitudeDegrees)
```
    Constructs a newly allocated GPSData object
- Method Detail
  - setLongitudeDegrees
```
public GPSData setLongitudeDegrees(@NonNull
                                   Double longitudeDegrees)
```
    set longitude degrees
    
    Parameters:
    
    longitudeDegrees - degrees of the longitudinal position
  - getLongitudeDegrees
```
public Double getLongitudeDegrees()
```
    get longitude degrees
    
    Returns:
    
    longitude degrees
  - setLatitudeDegrees
```
public GPSData setLatitudeDegrees(@NonNull
                                  Double latitudeDegrees)
```
    set latitude degrees
    
    Parameters:
    
    latitudeDegrees - degrees of the latitudinal position
  - getLatitudeDegrees
```
public Double getLatitudeDegrees()
```
    get latitude degrees
    
    Returns:
    
    latitude degrees
  - setUtcYear
```
public GPSData setUtcYear(Integer utcYear)
```
    set utc year
    
    Parameters:
    
    utcYear - utc year
  - getUtcYear
```
public Integer getUtcYear()
```
    get utc year
    
    Returns:
    
    utc year
  - setUtcMonth
```
public GPSData setUtcMonth(Integer utcMonth)
```
    set utc month
    
    Parameters:
    
    utcMonth - utc month
  - getUtcMonth
```
public Integer getUtcMonth()
```
    get utc month
    
    Returns:
    
    utc month
  - setUtcDay
```
public GPSData setUtcDay(Integer utcDay)
```
    set utc day
    
    Parameters:
    
    utcDay - utc day
  - getUtcDay
```
public Integer getUtcDay()
```
    get utc day
    
    Returns:
    
    utc day
  - setUtcHours
```
public GPSData setUtcHours(Integer utcHours)
```
    set utc hours
    
    Parameters:
    
    utcHours - utc hours
  - getUtcHours
```
public Integer getUtcHours()
```
    get utc hours
    
    Returns:
    
    utc hours
  - setUtcMinutes
```
public GPSData setUtcMinutes(Integer utcMinutes)
```
    set utc minutes
    
    Parameters:
    
    utcMinutes - utc minutes
  - getUtcMinutes
```
public Integer getUtcMinutes()
```
    get utc minutes
    
    Returns:
    
    utc minutes
  - setUtcSeconds
```
public GPSData setUtcSeconds(Integer utcSeconds)
```
    set utc seconds
    
    Parameters:
    
    utcSeconds - utc seconds
  - getUtcSeconds
```
public Integer getUtcSeconds()
```
    get utc seconds
    
    Returns:
    
    utc seconds
  - setCompassDirection
```
public GPSData setCompassDirection(CompassDirection compassDirection)
```
  - getCompassDirection
```
public CompassDirection getCompassDirection()
```
  - setPdop
```
public GPSData setPdop(Double pdop)
```
    set the positional dilution of precision
    
    Parameters:
    
    pdop - the positional dilution of precision
  - getPdop
```
public Double getPdop()
```
    get the positional dilution of precision
  - setHdop
```
public GPSData setHdop(Double hdop)
```
    set the horizontal dilution of precision
    
    Parameters:
    
    hdop - the horizontal dilution of precision
  - getHdop
```
public Double getHdop()
```
    get the horizontal dilution of precision
    
    Returns:
    
    the horizontal dilution of precision
  - setVdop
```
public GPSData setVdop(Double vdop)
```
    set the vertical dilution of precision
    
    Parameters:
    
    vdop - the vertical dilution of precision
  - getVdop
```
public Double getVdop()
```
    get the vertical dilution of precision
    
    Returns:
    
    the vertical dilution of precision
  - setActual
```
public GPSData setActual(Boolean actual)
```
    set what coordinates based on
    
    Parameters:
    
    actual - True, if coordinates are based on satellites.False, if based on dead reckoning
  - getActual
```
public Boolean getActual()
```
    get what coordinates based on
    
    Returns:
    
    True, if coordinates are based on satellites.False, if based on dead reckoning
  - setSatellites
```
public GPSData setSatellites(Integer satellites)
```
    set the number of satellites in view
    
    Parameters:
    
    satellites - the number of satellites in view
  - getSatellites
```
public Integer getSatellites()
```
    get the number of satellites in view
    
    Returns:
    
    the number of satellites in view
  - setDimension
```
public GPSData setDimension(Dimension dimension)
```
  - getDimension
```
public Dimension getDimension()
```
  - setAltitude
```
public GPSData setAltitude(Double altitude)
```
    set altitude in meters
    
    Parameters:
    
    altitude - altitude in meters
  - getAltitude
```
public Double getAltitude()
```
    get altitude in meters
    
    Returns:
    
    altitude in meters
  - setHeading
```
public GPSData setHeading(Double heading)
```
    set the heading.North is 0, East is 90, etc.
    
    Parameters:
    
    heading - the heading.
  - getHeading
```
public Double getHeading()
```
    get the heading
  - setSpeed
```
public GPSData setSpeed(Double speed)
```
    set speed in KPH
    
    Parameters:
    
    speed - the speed
  - getSpeed
```
public Double getSpeed()
```
    get the speed in KPH
    
    Returns:
    
    the speed in KPH
  - setShifted
```
public GPSData setShifted(Boolean shifted)
```
    Sets the shifted param for GPSData.
    
    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
```
public Boolean getShifted()
```
    Gets the shifted param for GPSData.
    
    Returns:
    
    Boolean - True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a proprietary algorithm to unshift).

Class GPSData

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_LONGITUDE_DEGREES

KEY_LATITUDE_DEGREES

KEY_UTC_YEAR

KEY_UTC_MONTH

KEY_UTC_DAY

KEY_UTC_HOURS

KEY_UTC_MINUTES

KEY_UTC_SECONDS

KEY_COMPASS_DIRECTION

KEY_PDOP

KEY_VDOP

KEY_HDOP

KEY_ACTUAL

KEY_SATELLITES

KEY_DIMENSION

KEY_ALTITUDE

KEY_HEADING

KEY_SPEED

KEY_SHIFTED

Constructor Detail

GPSData

GPSData

GPSData

Method Detail

setLongitudeDegrees

getLongitudeDegrees

setLatitudeDegrees

getLatitudeDegrees

setUtcYear

getUtcYear

setUtcMonth

getUtcMonth

setUtcDay

getUtcDay

setUtcHours

getUtcHours

setUtcMinutes

getUtcMinutes

setUtcSeconds

getUtcSeconds

setCompassDirection

getCompassDirection

setPdop

getPdop

setHdop

getHdop

setVdop

getVdop

setActual

getActual

setSatellites

getSatellites

setDimension

getDimension

setAltitude

getAltitude

setHeading

getHeading

setSpeed

getSpeed

setShifted

getShifted