net.sf.marineapi.nmea.sentence

Interface GGASentence

All Superinterfaces:

PositionSentence, Sentence, TimeSentence

public interface GGASentence
extends PositionSentence, TimeSentence

Global Positioning System fix data. Current position, time and other fix related data for a GPS receiver.

Example:
$GPGGA,120044,6011.552,N,02501.941,E,1,00,2.0,28.0,M,19.6,M,,*79

Author:

Kimmo Tuukkanen

Field Summary

Fields

Modifier and Type	Field and Description
static char	ALT_UNIT_FEET Altitude presented in feet.
static char	ALT_UNIT_METERS Altitude presented in meters.

Fields inherited from interface net.sf.marineapi.nmea.sentence.Sentence

ALTERNATIVE_BEGIN_CHAR, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR

Method Summary

Modifier and Type	Method and Description
double	getAltitude() Get antenna altitude above mean sea level.
Units	getAltitudeUnits() Gets the altitude units, meters or feet.
double	getDgpsAge() Gets the age of differential GPS data (DGPS).
String	getDgpsStationId() Gets the ID of DGPS station.
GpsFixQuality	getFixQuality() Get the GPS fix quality.
double	getGeoidalHeight() Get height/separation of geoid above WGS84 ellipsoid, i.e. difference between WGS-84 earth ellipsoid and mean sea level.
Units	getGeoidalHeightUnits() Get units of height above geoid.
double	getHorizontalDOP() Get the horizontal dilution of precision (HDOP), i.e. the relative accuracy of horizontal position.
int	getSatelliteCount() Get the number of active satellites in use.
void	setAltitude(double alt) Set the antenna altitude.
void	setAltitudeUnits(Units unit) Sets the unit of altitude.
void	setDgpsAge(double age) Sets the age of differential GPS data (DGPS).
void	setDgpsStationId(String id) Sets the ID of DGPS station.
void	setFixQuality(GpsFixQuality quality) Sets the GPS fix quality.
void	setGeoidalHeight(double height) Set height/separation of geoid above WGS84 ellipsoid, i.e. difference between WGS-84 earth ellipsoid and mean sea level.
void	setGeoidalHeightUnits(Units unit) Get unit of height above geoid.
void	setHorizontalDOP(double hdop) Set the horizontal dilution of precision (HDOP), i.e. the relative accuracy of horizontal position.
void	setSatelliteCount(int count) Sets the number of active satellites in use.

Methods inherited from interface net.sf.marineapi.nmea.sentence.PositionSentence

getPosition, setPosition

Methods inherited from interface net.sf.marineapi.nmea.sentence.TimeSentence

getTime, setTime

Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence

getBeginChar, getFieldCount, getSentenceId, getTalkerId, isAISSentence, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString

Field Detail

ALT_UNIT_METERS

static final char ALT_UNIT_METERS

Altitude presented in meters.

See Also:

Constant Field Values

ALT_UNIT_FEET

static final char ALT_UNIT_FEET

Altitude presented in feet.

See Also:

Constant Field Values

Method Detail

getAltitude

double getAltitude()

Get antenna altitude above mean sea level.

Returns:

Altitude value

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getAltitudeUnits

Units getAltitudeUnits()

Gets the altitude units, meters or feet.

Returns:

Units enum

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getDgpsAge

double getDgpsAge()

Gets the age of differential GPS data (DGPS).

Returns:

Seconds since last valid RTCM transmission

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getDgpsStationId

String getDgpsStationId()

Gets the ID of DGPS station.

Returns:

Station ID (0000-1024)

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getFixQuality

GpsFixQuality getFixQuality()

Get the GPS fix quality.

Returns:

GpsFixQuality enum

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getGeoidalHeight

double getGeoidalHeight()

Get height/separation of geoid above WGS84 ellipsoid, i.e. difference between WGS-84 earth ellipsoid and mean sea level. Negative values are below WGS-84 ellipsoid.

Returns:

Height value

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getGeoidalHeightUnits

Units getGeoidalHeightUnits()

Get units of height above geoid.

Returns:

Units of geoidal height value

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), i.e. the relative accuracy of horizontal position.

Returns:

Horizontal dilution

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

getSatelliteCount

int getSatelliteCount()

Get the number of active satellites in use.

Returns:

Number of satellites

Throws:

DataNotAvailableException - If the data is not available.

ParseException - If the field contains unexpected or illegal value.

setAltitude

void setAltitude(double alt)

Set the antenna altitude.

Parameters:

alt - Altitude to set

setAltitudeUnits

void setAltitudeUnits(Units unit)

Sets the unit of altitude.

Parameters:

unit - Units to set

setDgpsAge

void setDgpsAge(double age)

Sets the age of differential GPS data (DGPS).

Parameters:

age - Seconds since last valid RTCM transmission to set.

setDgpsStationId

void setDgpsStationId(String id)

Sets the ID of DGPS station.

Parameters:

id - Station ID to set

setFixQuality

void setFixQuality(GpsFixQuality quality)

Sets the GPS fix quality.

Parameters:

quality - Fix quality to set

setGeoidalHeight

void setGeoidalHeight(double height)

Set height/separation of geoid above WGS84 ellipsoid, i.e. difference between WGS-84 earth ellipsoid and mean sea level. Negative values are below WGS-84 ellipsoid.

Parameters:

height - Height value to set

setGeoidalHeightUnits

void setGeoidalHeightUnits(Units unit)

Get unit of height above geoid.

Parameters:

unit - Unit to set

setHorizontalDOP

void setHorizontalDOP(double hdop)

Set the horizontal dilution of precision (HDOP), i.e. the relative accuracy of horizontal position.

Parameters:

hdop - Horizontal dilution

setSatelliteCount

void setSatelliteCount(int count)

Sets the number of active satellites in use.

Parameters:

count - Number of satellites to set.

Throws:

IllegalArgumentException - If given count is negative.