GPSData (navigationSDK API)

java.lang.Object
- com.ptvag.navigation.sdk.GPSData

```
public class GPSData
extends java.lang.Object
```
Contains information received from a real GPS receiver, data which is generated by parsing an externally provided NMEA data stream or by parsing a recorded GPS track.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean jniCMemOwn

protected long jniCPtr

com.ptvag.navigation.sdk.NativeObject parent

Fields
Modifier and Type	Field and Description
`protected boolean`	`jniCMemOwn`
`protected long`	`jniCPtr`
`com.ptvag.navigation.sdk.NativeObject`	`parent`

Constructor Summary

Constructors
Constructor and Description

GPSData()
Constructor

GPSData(long cPtr, boolean cMemoryOwn)
Only for internal use - don't try to call this from Java.

Constructors
Constructor and Description
`GPSData()` Constructor
`GPSData(long cPtr, boolean cMemoryOwn)` Only for internal use - don't try to call this from Java.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Kills rubbish if owning the object.
`protected void`	`finalize()`
`int`	`getAltitude()` Returns the altitude [m] as reported from GPS (may or may not include geoid correction).
`int`	`getCourse()` Returns the navigation direction ([0..360[ 0=East, 90=North).
`static long`	`getCPtr(com.ptvag.navigation.sdk.NativeObject obj)`
`java.util.Date`	`getDate()` Returns a timestamp with the following information: Date of fix [day of month * 10000 + month of year * 100 + (year>=2000)?
`int`	`getExtraPolatedCourse()` Returns the extrapolated Navigation direction ([0..360[ 0=East, 90=North)
`Position`	`getExtraPolatedPos()` Returns the extrapolated position.
`int`	`getExtraPolatedVelocity()` Returns the extrapolated Velocity [km/h].
`short`	`getFix()`
`int`	`getGeoidSep()` Returns the applied Geoid separation [m].
`GeoPosition`	`getGPSPosition()` Returns the current position.
`Position`	`getGPSPositionMerc()` Returns the current position in format `CoordinateSystem.MERCATOR`. .
`short`	`getNoSats()` Returns the number of satellites used for the fix.
`short`	`getNoSatsInView()` Returns the number of satellites in view.
`int`	`getQuality()` Returns the quality of the signal in percent, i.e. 0 for lowest, 100 for best precision.
`java.sql.Time`	`getTime()` Returns a timestamp with the following information: Time of fix [Hour of day * 1000000 + minute of hour * 10000 + second of minute * 100 + hundreds of a second].
`int`	`getVelocity()` Returns the velocity [km/h].
`boolean`	`isExtraPolated()`
`void`	`setAltitude(int altitude)` Sets the altitude [m] as reported from GPS.
`void`	`setCourse(int course)` Sets the navigation direction ([0..360[ 0=East, 90=North).
`void`	`setDate(java.util.Calendar date)` Sets the date of the given `Calendar` as Gps date.
`void`	`setDate(int date)`
`void`	`setDateAndTime(java.util.Calendar dateTime)` Sets the date and time of the Gps data by the given `Calendar` object.
`void`	`setExtraPolatedCourse(int extraPolatedCourse)` Sets the extrapolated Navigation direction ([0..360[ 0=East, 90=North).
`void`	`setExtraPolatedPos(Position extraPolatedPos)` Sets the extrapolated position.
`void`	`setExtraPolatedVelocity(int extraPolatedVelocity)` Sets the extrapolated Velocity [km/h].
`void`	`setFix(short fix)` Sets the fix information. 0 if GPS device has no fix, >0 for a valid fix: 1=GPS (inkl. 2d/3d), 2=differential GPS (DGPS), 3= dead reckoning mode (DR), 4=unknown
`void`	`setGeoidSep(int geoidSep)` Sets the applied Geoid separation [m].
`void`	`setGPSPosition(GeoPosition gpsPosition)` Sets the GeoPosition.
`void`	`setGPSPositionMerc(Position gpsPositionMerc)` Sets the current position (Mercator).
`void`	`setIsExtraPolated(boolean isExtraPolated)` Sets whether the information is based on (software) internal extrapolation.
`void`	`setNoSats(short noSats)` Sets the number of satellites used for the fix.
`void`	`setNoSatsInView(short noSatsInView)` Sets the number of satellites in view.
`void`	`setQuality(int quality)` Sets the quality of the signal in percent, i.e. 0 for lowest, 100 for best precision.
`void`	`setTime(java.util.Calendar time)` Sets the time of the given `Calendar` as Gps time.
`void`	`setTime(int time)`
`void`	`setVelocity(int velocity)` Sets the velocity [km/h].
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - jniCPtr
```
protected long jniCPtr
```
  - jniCMemOwn
```
protected boolean jniCMemOwn
```
  - parent
```
public com.ptvag.navigation.sdk.NativeObject parent
```
- Constructor Detail
  - GPSData
```
public GPSData()
```
    Constructor
  - GPSData
```
public GPSData(long cPtr,
               boolean cMemoryOwn)
```
    Only for internal use - don't try to call this from Java.
- Method Detail
  - getGPSPosition
```
public GeoPosition getGPSPosition()
```
    Returns the current position.
    
    Returns:
    
    the current position
  - getGPSPositionMerc
```
public Position getGPSPositionMerc()
```
    Returns the current position in format CoordinateSystem.MERCATOR. .
    
    Returns:
    
    the current position in format CoordinateSystem.MERCATOR.
  - getAltitude
```
public int getAltitude()
```
    Returns the altitude [m] as reported from GPS (may or may not include geoid correction).
    
    Returns:
    
    the altitude [m] as reported from GPS.
  - getVelocity
```
public int getVelocity()
```
    Returns the velocity [km/h].
    
    Returns:
    
    the velocity.
  - getCourse
```
public int getCourse()
```
    Returns the navigation direction ([0..360[ 0=East, 90=North).
    
    Returns:
    
    the navigation direction.
  - getQuality
```
public int getQuality()
```
    Returns the quality of the signal in percent, i.e. 0 for lowest, 100 for best precision.
    
    Returns:
    
    quality of the signal in percent.
  - getNoSats
```
public short getNoSats()
```
    Returns the number of satellites used for the fix.
    
    Returns:
    
    the number of satellites used for the fix.
  - getDate
```
public java.util.Date getDate()
```
    Returns a timestamp with the following information: Date of fix [day of month * 10000 + month of year * 100 + (year>=2000)?(year-2000):(year-1990)]
    
    Returns:
    
    the date of fix.
  - getTime
```
public java.sql.Time getTime()
```
    Returns a timestamp with the following information: Time of fix [Hour of day * 1000000 + minute of hour * 10000 + second of minute * 100 + hundreds of a second]. Note that for navigation purposes at least a valid time (>0) has to be provided, otherwise navigation fails!
    
    Returns:
    
    the time of fix.
  - setGPSPosition
```
public void setGPSPosition(GeoPosition gpsPosition)
```
    Sets the GeoPosition.
    
    Parameters:
    
    gpsPosition - the GeoPosition to set.
  - setGPSPositionMerc
```
public void setGPSPositionMerc(Position gpsPositionMerc)
```
    Sets the current position (Mercator).
    
    Parameters:
    
    gpsPositionMerc - the current position (Mercator) to set.
  - setAltitude
```
public void setAltitude(int altitude)
```
    Sets the altitude [m] as reported from GPS.
    
    Parameters:
    
    altitude - the altitude [m] as reported from GPS to set.
  - setVelocity
```
public void setVelocity(int velocity)
```
    Sets the velocity [km/h].
    
    Parameters:
    
    velocity - to set.
  - setCourse
```
public void setCourse(int course)
```
    Sets the navigation direction ([0..360[ 0=East, 90=North).
    
    Parameters:
    
    course - the navigation direction to set.
  - setQuality
```
public void setQuality(int quality)
```
    Sets the quality of the signal in percent, i.e. 0 for lowest, 100 for best precision.
    
    Parameters:
    
    quality - the quality of the signal
  - setNoSats
```
public void setNoSats(short noSats)
```
    Sets the number of satellites used for the fix.
    
    Parameters:
    
    noSats - the number of satellites.
  - getFix
```
public short getFix()
```
    Returns:
    
    0 if GPS device has no fix, >0 for a valid fix: 1=GPS (inkl. 2d/3d), 2=differential GPS (DGPS), 3= dead reckoning mode (DR), 4=unknown
  - setFix
```
public void setFix(short fix)
```
    Sets the fix information. 0 if GPS device has no fix, >0 for a valid fix: 1=GPS (inkl. 2d/3d), 2=differential GPS (DGPS), 3= dead reckoning mode (DR), 4=unknown
    
    Parameters:
    
    fix - the fix information to set.
  - setDateAndTime
```
public void setDateAndTime(java.util.Calendar dateTime)
```
    Sets the date and time of the Gps data by the given Calendar object. To set the date and time the methods setDate(Calendar) and setTime(Calendar) are called.
    
    Parameters:
    
    dateTime - The Calendar object which contains the date and time information.
  - setDate
```
public void setDate(java.util.Calendar date)
```
    Sets the date of the given Calendar as Gps date. The Gps date is calculated by the formula: gps date = day of month * 10000 + month of year * 100 + (year>=2000) ? (year-2000) : (year-1990).
    
    Parameters:
    
    date - The date as Calendar object.
  - setTime
```
public void setTime(java.util.Calendar time)
```
    Sets the time of the given Calendar as Gps time. The Gps time is calculated by the formula: gps time = hour of day * 1000000 + minute of hour * 10000 + second of minute * 100 + hundreds of a second.
    
    Parameters:
    
    time - The time as Calendar object.
  - getGeoidSep
```
public int getGeoidSep()
```
    Returns the applied Geoid separation [m].
    
    Returns:
    
    the applied Geoid separation [m].
  - setGeoidSep
```
public void setGeoidSep(int geoidSep)
```
    Sets the applied Geoid separation [m].
    
    Parameters:
    
    geoidSep - the applied Geoid separation to set
  - getNoSatsInView
```
public short getNoSatsInView()
```
    Returns the number of satellites in view.
    
    Returns:
    
    the number of satellites in view.
  - setNoSatsInView
```
public void setNoSatsInView(short noSatsInView)
```
    Sets the number of satellites in view.
    
    Parameters:
    
    noSatsInView - the number of satellites in view to set.
  - isExtraPolated
```
public boolean isExtraPolated()
```
    Returns:
    
    whether the information is based on (software) internal extrapolation.
  - setIsExtraPolated
```
public void setIsExtraPolated(boolean isExtraPolated)
```
    Sets whether the information is based on (software) internal extrapolation.
    
    Parameters:
    
    isExtraPolated - the information is based on (software) internal extrapolation.
  - getExtraPolatedPos
```
public Position getExtraPolatedPos()
```
    Returns the extrapolated position.
    
    Returns:
    
    the extrapolated position.
  - setExtraPolatedPos
```
public void setExtraPolatedPos(Position extraPolatedPos)
```
    Sets the extrapolated position.
    
    Parameters:
    
    extraPolatedPos - the extrapolated position to set.
  - getExtraPolatedVelocity
```
public int getExtraPolatedVelocity()
```
    Returns the extrapolated Velocity [km/h].
    
    Returns:
    
    the extrapolated Velocity [km/h].
  - setExtraPolatedVelocity
```
public void setExtraPolatedVelocity(int extraPolatedVelocity)
```
    Sets the extrapolated Velocity [km/h].
    
    Parameters:
    
    extraPolatedVelocity - the extrapolated Velocity to set.
  - getExtraPolatedCourse
```
public int getExtraPolatedCourse()
```
    Returns the extrapolated Navigation direction ([0..360[ 0=East, 90=North)
    
    Returns:
    
    the extrapolated Navigation direction. }
  - setExtraPolatedCourse
```
public void setExtraPolatedCourse(int extraPolatedCourse)
```
    Sets the extrapolated Navigation direction ([0..360[ 0=East, 90=North).
    
    Parameters:
    
    extraPolatedCourse - the extrapolated Navigation direction to set.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setTime
```
public void setTime(int time)
```
  - setDate
```
public void setDate(int date)
```
  - getCPtr
```
public static long getCPtr(com.ptvag.navigation.sdk.NativeObject obj)
```
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - delete
```
public void delete()
```
    Kills rubbish if owning the object.

Class GPSData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jniCPtr

jniCMemOwn

parent

Constructor Detail

GPSData

GPSData

Method Detail

getGPSPosition

getGPSPositionMerc

getAltitude

getVelocity

getCourse

getQuality

getNoSats

getDate

getTime

setGPSPosition

setGPSPositionMerc

setAltitude

setVelocity

setCourse

setQuality

setNoSats

getFix

setFix

setDateAndTime

setDate

setTime

getGeoidSep

setGeoidSep

getNoSatsInView

setNoSatsInView

isExtraPolated

setIsExtraPolated

getExtraPolatedPos

setExtraPolatedPos

getExtraPolatedVelocity

setExtraPolatedVelocity

getExtraPolatedCourse

setExtraPolatedCourse

toString

setTime

setDate

getCPtr

finalize

delete