IGPSService

```
public interface IGPSService
```
Gets data from GPS device. Copyright (C) 2009 Eurotech Inc. All rights reserved.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String SERVICE_NAME
Helper method.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`SERVICE_NAME` Helper method.

Method Summary

Methods
Modifier and Type	Method and Description
`float`	`getAltitude()` Returns the current altitude reported by the GPS device
`java.lang.String`	`getFOM()` Returns the most recent FOM message
`java.lang.String`	`getGPGGA()` Returns the most recent GPGGA message
`java.lang.String`	`getGPGLL()` Returns the most recent GPGLL message
`java.lang.String`	`getGPGSA()` Returns the most recent GPGSA message
`java.lang.String`	`getGPGSV1()` Returns the most recent GPGSV1 message
`java.lang.String`	`getGPGSV2()` Returns the most recent GPGSV2 message
`java.lang.String`	`getGPGSV3()` Returns the most recent GPGSV3 message
`java.lang.String`	`getGPGSV4()` Returns the most recent GPGSV4 message
`java.lang.String`	`getGPRMC()` Returns the most recent GPRMC message
`boolean`	`getGpsLock()` Returns a boolean value indicating if the GPS input stream indicates a GPS position fix.
`java.lang.String`	`getGPVTG()` Returns the most recent GPVTG message
`int`	`getHeading()` Returns the current heading reported by the GPS device.
`float`	`getLat()` Returns the latitude value reported by the GPS device.
`float`	`getLon()` Returns the longitude value reported by the GPS device.
`int`	`getNumOfGSVMessages()` Returns the number of GPGSV messages currently available
`int`	`getPacc()` Returns the dilution of precision of the current satellite fix.
`java.lang.String`	`getPPS()` Returns the most recent PPS message
`int`	`getSats()` Returns the number satellites locked by the GPS device.
`float`	`getSpeedKPH()` Returns the speed reported by the GPS device.
`float`	`getSpeedMPH()` Returns the speed reported by the GPS device.
`int`	`getStat()` Returns a status indicator for the GPS data.
`long`	`getTime()` Returns the current GPS time in UTC seconds.
`boolean`	`isRunning()` Check the operational status of any functional operation associated with the implementation.
`void`	`restart()` Perform both the action of the stop and the start methods.
`void`	`sendCommand(java.lang.String command)` Sends a command to the GPS device
`void`	`setGpsBaudRate(int newBaudRate)` Set the baud rate to be used of the next open of the GPS serial port.
`void`	`setGpsPort(java.lang.String newPortName)` Set the serial port (Linux device name) that will be used to open a connection to the GPS receiver.
`void`	`setPersistent()` Store the current configuration (through @IConfigurationManagerService or in the OS as appropriate).
`boolean`	`setSystemTime()` Sets the system clock based on the GPS time.
`void`	`start()` The start method will start any functional operation associated with the specific implementation.
`void`	`stop()` The stop method will stop any functional operation started by the start method.

- Field Detail
  - SERVICE_NAME
```
static final java.lang.String SERVICE_NAME
```
    Helper method. Returns the class name of this Interface.
- Method Detail
  - setGpsPort
```
void setGpsPort(java.lang.String newPortName)
```
    Set the serial port (Linux device name) that will be used to open a connection to the GPS receiver. This port will be used on any subsequent call to enableStream().
    
    Parameters:
    newPortName - Linux device name of GPS serial port.
  - setGpsBaudRate
```
void setGpsBaudRate(int newBaudRate)
```
    Set the baud rate to be used of the next open of the GPS serial port. This value will be used on any subsequent call to enableStream().
    
    Parameters:
    newBaudRate - serial port baud rate
  - getGpsLock
```
boolean getGpsLock()
```
    Returns a boolean value indicating if the GPS input stream indicates a GPS position fix. If the GPS input stream is not currently available for any reason, then this value will be false.
    
    Returns:
    The position fix, as reported by the GPS receiver.
  - sendCommand
```
void sendCommand(java.lang.String command)
                 throws java.lang.Exception
```
    Sends a command to the GPS device
    
    Parameters:
    command - the string representing the command to send to the GPS device
    
    Throws:
    
    java.lang.Exception - if an I/O error occurred on the GPS port, or if the GPS is not enabled.
  - getGPGGA
```
java.lang.String getGPGGA()
```
    Returns the most recent GPGGA message
    
    Returns:
    the most recent GPGGA message
  - getGPGLL
```
java.lang.String getGPGLL()
```
    Returns the most recent GPGLL message
    
    Returns:
    the most recent GPGLL message
  - getGPGSA
```
java.lang.String getGPGSA()
```
    Returns the most recent GPGSA message
    
    Returns:
    the most recent GPGSA message
  - getNumOfGSVMessages
```
int getNumOfGSVMessages()
```
    Returns the number of GPGSV messages currently available
    
    Returns:
    the total number of GSV messages currently available
  - getGPGSV1
```
java.lang.String getGPGSV1()
```
    Returns the most recent GPGSV1 message
    
    Returns:
    the most recent GPGSV1 message
  - getGPGSV2
```
java.lang.String getGPGSV2()
```
    Returns the most recent GPGSV2 message
    
    Returns:
    the most recent GPGSV2 message
  - getGPGSV3
```
java.lang.String getGPGSV3()
```
    Returns the most recent GPGSV3 message
    
    Returns:
    the most recent GPGSV3 message
  - getGPGSV4
```
java.lang.String getGPGSV4()
```
    Returns the most recent GPGSV4 message
    
    Returns:
    the most recent GPGSV4 message
  - getGPRMC
```
java.lang.String getGPRMC()
```
    Returns the most recent GPRMC message
    
    Returns:
    the most recent GPRMC message
  - getGPVTG
```
java.lang.String getGPVTG()
```
    Returns the most recent GPVTG message
    
    Returns:
    the most recent GPVTG message
  - getFOM
```
java.lang.String getFOM()
```
    Returns the most recent FOM message
    
    Returns:
    the most recent FOM message
  - getPPS
```
java.lang.String getPPS()
```
    Returns the most recent PPS message
    
    Returns:
    the most recent PPS message
  - setSystemTime
```
boolean setSystemTime()
```
    Sets the system clock based on the GPS time. This will only occur if a valid GPS lock is available. If not, setSystemTime() will return false and not set the system time. Otherwise, the system time will be set and true will be returned
    
    Returns:
    boolean, true if the operation completed without errors
  - getTime
```
long getTime()
```
    Returns the current GPS time in UTC seconds.
    
    Returns:
    UTC time in seconds since Jan 1, 1970 00:00:00
  - getStat
```
int getStat()
```
    Returns a status indicator for the GPS data. Statuses are: 1 = no GPS response; 2 = error in response; 4 = valid.
    
    Returns:
    status
  - getSats
```
int getSats()
```
    Returns the number satellites locked by the GPS device.
    
    Returns:
    number of satellites locked by the GPS device.
  - getLat
```
float getLat()
```
    Returns the latitude value reported by the GPS device.
    
    Returns:
    latitude, in units of seconds.
  - getLon
```
float getLon()
```
    Returns the longitude value reported by the GPS device.
    
    Returns:
    longitude, in units of seconds, accurate to the nearest minute.
  - getSpeedMPH
```
float getSpeedMPH()
```
    Returns the speed reported by the GPS device.
    
    Returns:
    current speed, in miles per hour.
  - getSpeedKPH
```
float getSpeedKPH()
```
    Returns the speed reported by the GPS device.
    
    Returns:
    current speed, in kilometers per hour.
  - getHeading
```
int getHeading()
```
    Returns the current heading reported by the GPS device.
    
    Returns:
    heading in degrees.
  - getPacc
```
int getPacc()
```
    Returns the dilution of precision of the current satellite fix. DOP (dilution of precision) is an indication of the effect of satellite geometry on the accuracy of the fix. It is a unitless number where smaller is better. For 3D fixes using 4 satellites a 1.0 would be considered to be a perfect number, however for overdetermined solutions it is possible to see numbers below 1.0.
    
    Returns:
    dilution of precision
  - getAltitude
```
float getAltitude()
```
    Returns the current altitude reported by the GPS device
    
    Returns:
    altitude in feet
  - start
```
void start()
           throws java.lang.Exception
```
    The start method will start any functional operation associated with the specific implementation.
    
    Throws:
    
    java.lang.Exception - start failed (could be missing a configuration).
  - stop
```
void stop()
          throws java.lang.Exception
```
    The stop method will stop any functional operation started by the start method.
    
    Throws:
    
    java.lang.Exception - stop failed
  - restart
```
void restart()
             throws java.lang.Exception
```
    Perform both the action of the stop and the start methods. If the result of running the isRunning method prior to the call would be false, then restart only performs the same action as the start method.
    
    Throws:
    
    java.lang.Exception - restart failed (could be missing a configuration)
  - setPersistent
```
void setPersistent()
                   throws java.lang.Exception
```
    Store the current configuration (through @IConfigurationManagerService or in the OS as appropriate).
    
    Throws:
    
    java.lang.Exception - no current configuration to store
  - isRunning
```
boolean isRunning()
```
    Check the operational status of any functional operation associated with the implementation. Following a successful start, this should return true and following a successful stop, this should return false.
    
    Returns:
    true if the functional part of the implementation is running false if the functional part of the implementation is not running

Interface IGPSService

Field Summary

Method Summary

Field Detail

SERVICE_NAME

Method Detail

setGpsPort

setGpsBaudRate

getGpsLock

sendCommand

getGPGGA

getGPGLL

getGPGSA

getNumOfGSVMessages

getGPGSV1

getGPGSV2

getGPGSV3

getGPGSV4

getGPRMC

getGPVTG

getFOM

getPPS

setSystemTime

getTime

getStat

getSats

getLat

getLon

getSpeedMPH

getSpeedKPH

getHeading

getPacc

getAltitude

start

stop

restart

setPersistent

isRunning