net.sf.marineapi.nmea.sentence.GSVSentence Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.osgi.bundles.net.sf.marineapi Show documentation
Java Marine API is an NMEA 0183 library for Java (http://ktuukkan.github.io/marine-api/).
The newest version!
/* 
 * GSVSentence.java
 * Copyright (C) 2010 Kimmo Tuukkanen
 * 
 * This file is part of Java Marine API.
 * 
 * 
 * Java Marine API is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * Java Marine API is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Java Marine API. If not, see .
 */
package net.sf.marineapi.nmea.sentence;

import java.util.List;

import net.sf.marineapi.nmea.util.SatelliteInfo;

/**
 * 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
 */
public interface GSVSentence extends Sentence {

	/**
	 * Get the number of satellites in view.
	 * 
	 * @return Satellite count
	 */
	int getSatelliteCount();

	/**
	 * Get the satellites information.
	 * 
	 * @return List of SatelliteInfo objects.
	 */
	List getSatelliteInfo();

	/**
	 * Get the total number of sentences in GSV sequence.
	 * 
	 * @return Number of sentences
	 */
	int getSentenceCount();

	/**
	 * Get the index of this sentence in GSV sequence.
	 * 
	 * @return Sentence index
	 */
	int getSentenceIndex();

	/**
	 * Tells if this is the first sentence in GSV sequence.
	 * 
	 * @return true if first, otherwise false.
	 * @see #getSentenceCount()
	 * @see #getSentenceIndex()
	 */
	boolean isFirst();

	/**
	 * Tells if this is the last sentence in GSV sequence. This is a convenience
	 * method for comparison of
	 * ({@link #getSentenceCount()} == {@link #getSentenceIndex()})
	 * .
	 * 
	 * @return true if first, otherwise false.
	 */
	boolean isLast();

	/**
	 * Set the number of satellites in view.
	 * 
	 * @param count Satellite count
	 * @throws IllegalArgumentException If specified number is negative
	 */
	void setSatelliteCount(int count);

	/**
	 * Set the satellite information.
	 * 
	 * @param 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).
	 */
	void setSatelliteInfo(List info);

	/**
	 * Set the total number of sentences in GSV sequence.
	 * 
	 * @param count Number of sentences
	 * @throws IllegalArgumentException If specified count is negative
	 */
	void setSentenceCount(int count);

	/**
	 * Set the index of this sentence in GSV sequence.
	 * 
	 * @param index Sentence index to set
	 * @throws IllegalArgumentException If specified index is negative
	 */
	void setSentenceIndex(int index);

}