net.sf.marineapi.nmea.sentence

Interface GNSSentence

All Superinterfaces:

PositionSentence, Sentence, TimeSentence

public interface GNSSentence
extends Sentence, PositionSentence, TimeSentence

GNSS capable receivers will always output this message with the GN talker ID. GNSS capable receivers will also output this message with the GP and/or GL talker ID when using more than one constellation for the position fix.

Example:

 $GNGNS,014035.00,4332.69262,S,17235.48549,E,RR,13,0.9,25.63,11.24,,*70
 $GPGNS,014035.00,,,,,,8,,,,1.0,23*76
 $GLGNS,014035.00,,,,,,5,,,,1.0,23*67
 

Author:

Kimmo Tuukkanen

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GNSSentence.Mode GNS operational modes, a mix of FaaMode and GpsFixQuality with some values omitted.

Field Summary

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
GNSSentence.Mode[]	getAdditionalModes() Returns all additional operation modes, excluding GPS and GLONASS.
double	getDgpsAge() Returns the age of differential GPS data.
String	getDgpsStationId() Returns the differential reference station ID.
double	getGeoidalSeparation() Returns geoidal separation, the difference between the earth ellipsoid surface and mean-sea-level (geoid) surface defined by the reference datum used in the position solution.
GNSSentence.Mode	getGlonassMode() Gets the current GLONASS mode.
GNSSentence.Mode	getGpsMode() Returns the current GPS mode.
double	getHorizontalDOP() Returns the Horizontal Dilution Of Precision, calculated using all available satellites (GPS, GLONASS and any future satellites).
double	getOrthometricHeight() Returns the orthometric height (MSL reference).
int	getSatelliteCount() Get the number of active satellites in use for currect fix.
void	setAdditionalModes(GNSSentence.Mode... modes) Sets the additional operational modes, leaving GPS and GLONASS modes unaffected or setting them both NONE if field is empty.
void	setDgpsAge(double age) Sets the age of differential GPS data.
void	setDgpsStationId(String id) Sets the differential reference station ID.
void	setGeoidalSeparation(double separation) Returns geoidal separation, the difference between the earth ellipsoid surface and mean-sea-level (geoid) surface defined by the reference datum used in the position solution.
void	setGlonassMode(GNSSentence.Mode gns) Sets the current GLONASS mode.
void	setGpsMode(GNSSentence.Mode gps) Sets the current GPS mode.
void	setHorizontalDOP(double hdop) Sets the Horizontal Dilution Of Precision value, calculated using all available satellites (GPS, GLONASS and any future satellites).
void	setOrthometricHeight(double height) Sets the orthometric height (MSL reference).
void	setSatelliteCount(int count) Sets the number of satellites used for current fix.

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

Method Detail

getGpsMode

GNSSentence.Mode getGpsMode()

Returns the current GPS mode.

Returns:

GPS operational mode

setGpsMode

void setGpsMode(GNSSentence.Mode gps)

Sets the current GPS mode.

Parameters:

gps - GPS operational mode to set.

getGlonassMode

GNSSentence.Mode getGlonassMode()

Gets the current GLONASS mode.

Returns:

GLONASS operational mode

setGlonassMode

void setGlonassMode(GNSSentence.Mode gns)

Sets the current GLONASS mode.

Parameters:

gns - GLONASS operational mode to set.

getAdditionalModes

GNSSentence.Mode[] getAdditionalModes()

Returns all additional operation modes, excluding GPS and GLONASS.

Returns:

Array of additional modes or empty array if no modes are set.

setAdditionalModes

void setAdditionalModes(GNSSentence.Mode... modes)

Sets the additional operational modes, leaving GPS and GLONASS modes unaffected or setting them both NONE if field is empty.

Parameters:

modes - Array of additional modes to set

getSatelliteCount

int getSatelliteCount()

Get the number of active satellites in use for currect fix.

Returns:

Number of satellites 0..99

setSatelliteCount

void setSatelliteCount(int count)

Sets the number of satellites used for current fix.

Parameters:

count - Number of satellites to set

Throws:

IllegalArgumentException - If given count is out of bounds 0..99

getHorizontalDOP

double getHorizontalDOP()

Returns the Horizontal Dilution Of Precision, calculated using all available satellites (GPS, GLONASS and any future satellites).

Returns:

HDOP value

setHorizontalDOP

void setHorizontalDOP(double hdop)

Sets the Horizontal Dilution Of Precision value, calculated using all available satellites (GPS, GLONASS and any future satellites).

Parameters:

hdop - HDOP value to set

getOrthometricHeight

double getOrthometricHeight()

Returns the orthometric height (MSL reference).

Returns:

Height in meters

setOrthometricHeight

void setOrthometricHeight(double height)

Sets the orthometric height (MSL reference).

Parameters:

height - Height to set, in meters.

getGeoidalSeparation

double getGeoidalSeparation()

Returns geoidal separation, the difference between the earth ellipsoid surface and mean-sea-level (geoid) surface defined by the reference datum used in the position solution. Negative values denote mean-sea-level surface below ellipsoid.

Returns:

Geoidal separation in meters.

setGeoidalSeparation

void setGeoidalSeparation(double separation)

Returns geoidal separation, the difference between the earth ellipsoid surface and mean-sea-level (geoid) surface defined by the reference datum used in the position solution. Negative values denote mean-sea-level surface below ellipsoid.

Parameters:

separation - Geoidal separation in meters.

getDgpsAge

double getDgpsAge()

Returns the age of differential GPS data.

Notice: field is null when Talker ID is GN, additional GNS messages follow with GP and/or GL age of differential data.

Returns:

Age of differential data.

setDgpsAge

void setDgpsAge(double age)

Sets the age of differential GPS data.

Notice: field is null when Talker ID is GN, additional GNS messages follow with GP and/or GL age of differential data.

Parameters:

age - Age to set, negative values will reset the field empty.

getDgpsStationId

String getDgpsStationId()

Returns the differential reference station ID.

Returns:

Station ID, 0000..4095

setDgpsStationId

void setDgpsStationId(String id)

Sets the differential reference station ID.

Parameters:

id - Station ID to set, 0-4095