net.sf.marineapi.nmea.sentence

Interface GSVSentence

All Superinterfaces:

Sentence

public interface GSVSentence
extends Sentence

Detailed GPS satellite data; satellites in view, satellite elevation, azimuth and signal noise ratio (SNR). GSV sentences are transmitted typically in groups of two or three sentences, depending on the number of satellites in view. Each GSV sentence may contain information about up to four satellites. The last sentence in sequence may contain empty satellite information fields. The empty fields may also be omitted, depending on the device model and manufacturer.

Example:
$GPGSV,3,2,12,15,56,182,51,17,38,163,47,18,63,058,50,21,53,329,47*73

Author:

Kimmo Tuukkanen

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
int	getSatelliteCount() Get the number of satellites in view.
List<SatelliteInfo>	getSatelliteInfo() Get the satellites information.
int	getSentenceCount() Get the total number of sentences in GSV sequence.
int	getSentenceIndex() Get the index of this sentence in GSV sequence.
boolean	isFirst() Tells if this is the first sentence in GSV sequence.
boolean	isLast() Tells if this is the last sentence in GSV sequence.
void	setSatelliteCount(int count) Set the number of satellites in view.
void	setSatelliteInfo(List<SatelliteInfo> info) Set the satellite information.
void	setSentenceCount(int count) Set the total number of sentences in GSV sequence.
void	setSentenceIndex(int index) Set the index of this sentence in GSV sequence.

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

getSatelliteCount

int getSatelliteCount()

Get the number of satellites in view.

Returns:

Satellite count

getSatelliteInfo

List<SatelliteInfo> getSatelliteInfo()

Get the satellites information.

Returns:

List of SatelliteInfo objects.

getSentenceCount

int getSentenceCount()

Get the total number of sentences in GSV sequence.

Returns:

Number of sentences

getSentenceIndex

int getSentenceIndex()

Get the index of this sentence in GSV sequence.

Returns:

Sentence index

isFirst

boolean isFirst()

Tells if this is the first sentence in GSV sequence.

Returns:

true if first, otherwise false.

See Also:

getSentenceCount(), getSentenceIndex()

isLast

boolean isLast()

Tells if this is the last sentence in GSV sequence. This is a convenience method for comparison of (getSentenceCount() == getSentenceIndex()) .

Returns:

true if first, otherwise false.

setSatelliteCount

void setSatelliteCount(int count)

Set the number of satellites in view.

Parameters:

count - Satellite count

Throws:

IllegalArgumentException - If specified number is negative

setSatelliteInfo

void setSatelliteInfo(List<SatelliteInfo> info)

Set the satellite information.

Parameters:

info - List of SatelliteInfo objects, size from 0 to 4.

Throws:

IllegalArgumentException - If specified list size is greater that maximum allowed number of satellites per sentence (4).

setSentenceCount

void setSentenceCount(int count)

Set the total number of sentences in GSV sequence.

Parameters:

count - Number of sentences

Throws:

IllegalArgumentException - If specified count is negative

setSentenceIndex

void setSentenceIndex(int index)

Set the index of this sentence in GSV sequence.

Parameters:

index - Sentence index to set

Throws:

IllegalArgumentException - If specified index is negative