net.sf.marineapi.nmea.sentence
Interface GSASentence

All Superinterfaces:
Sentence

public interface GSASentence
extends Sentence

Precision of GPS fix and list of active satellites. Dilution of precision (DOP) is an indication of the effect of satellite geometry on the accuracy of the fix. It is a unitless number where smaller is better.

Example:
$GPGSA,A,3,02,,,07,,09,24,26,,,,,1.6,1.6,1.0*3D

Version:
$Revision: 34 $
Author:
Kimmo Tuukkanen

Field Summary
 
Fields inherited from interface net.sf.marineapi.nmea.sentence.Sentence
ADDRESS_FIELD, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR
 
Method Summary
 GpsFixStatus getFixStatus()
          Get the GPS fix mode; 2D, 3D or no fix.
 GpsMode getGpsMode()
          Get the GPS operation mode.
 double getHorizontalDOP()
          Get the horizontal dilution Of precision (HDOP).
 double getPositionDOP()
          Get the dilution of precision (PDOP) for position.
 String[] getSatellitesIds()
          Get list of satellites used for acquiring the GPS fix.
 double getVerticalDOP()
          Get the vertical dilution of precision (VDOP).
 void setFixStatus(GpsFixStatus status)
          Set the GPS fix mode; 2D, 3D or no fix.
 void setGpsMode(GpsMode mode)
          Set the GPS operation mode.
 void setHorizontalDOP(double hdop)
          Set the horizontal dilution of precision (HDOP).
 void setPositionDOP(double pdop)
          Set the dilution of precision for position.
 void setSatelliteIds(String[] ids)
          Set list of satellites used for acquiring the GPS fix.
 void setVerticalDOP(double vdop)
          Set the vertical dilution of precision (VDOP).
 
Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence
getFieldCount, getSentenceId, getTalkerId, isProprietary, isValid, setTalkerId, toSentence, toString
 

Method Detail

getFixStatus

GpsFixStatus getFixStatus()
Get the GPS fix mode; 2D, 3D or no fix.

Returns:
GpsFixStatus enum
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

getGpsMode

GpsMode getGpsMode()
Get the GPS operation mode.

Returns:
GpsMode enum
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

getHorizontalDOP

double getHorizontalDOP()
Get the horizontal dilution Of precision (HDOP).

Returns:
double
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

getPositionDOP

double getPositionDOP()
Get the dilution of precision (PDOP) for position.

Returns:
double
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

getSatellitesIds

String[] getSatellitesIds()
Get list of satellites used for acquiring the GPS fix.

Returns:
String array containing satellite IDs.
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

getVerticalDOP

double getVerticalDOP()
Get the vertical dilution of precision (VDOP).

Returns:
double
Throws:
DataNotAvailableException - If the data is not available.
ParseException - If the field contains unexpected or illegal value.

setFixStatus

void setFixStatus(GpsFixStatus status)
Set the GPS fix mode; 2D, 3D or no fix.

Parameters:
status - Status to set

setGpsMode

void setGpsMode(GpsMode mode)
Set the GPS operation mode.

Parameters:
mode - Mode to set

setHorizontalDOP

void setHorizontalDOP(double hdop)
Set the horizontal dilution of precision (HDOP).

Parameters:
hdop - Precision value to set

setPositionDOP

void setPositionDOP(double pdop)
Set the dilution of precision for position.

Parameters:
pdop - Precision value to set

setSatelliteIds

void setSatelliteIds(String[] ids)
Set list of satellites used for acquiring the GPS fix.

Parameters:
ids - List of satellite IDs, maximum length of array is 12.

setVerticalDOP

void setVerticalDOP(double vdop)
Set the vertical dilution of precision (VDOP).

Parameters:
vdop - Precision value to set


Copyright (C) 2010-2011 Java Marine API author(s). All Rights Reserved.