net.sf.marineapi.nmea.parser.GSVParser 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!
/* 
 * GSVParser.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.parser;

import java.util.ArrayList;
import java.util.List;

import net.sf.marineapi.nmea.sentence.GSVSentence;
import net.sf.marineapi.nmea.sentence.SentenceId;
import net.sf.marineapi.nmea.sentence.TalkerId;
import net.sf.marineapi.nmea.util.SatelliteInfo;

/**
 * GSV sentence parser.
 * 
 * @author Kimmo Tuukkanen
 */
class GSVParser extends SentenceParser implements GSVSentence {

	// field indices
	private static final int NUMBER_OF_SENTENCES = 0;
	private static final int SENTENCE_NUMBER = 1;
	private static final int SATELLITES_IN_VIEW = 2;

	// satellite id fields
	private static final int[] ID_FIELDS = { 3, 7, 11, 15 };

	// satellite data fields, relative to each id field
	private static final int ELEVATION = 1;
	private static final int AZIMUTH = 2;
	private static final int NOISE = 3;

	/**
	 * Constructor.
	 * 
	 * @param nmea GSV Sentence
	 */
	public GSVParser(String nmea) {
		super(nmea, SentenceId.GSV);
	}

	/**
	 * Creates an GSV parser with empty sentence.
	 * 
	 * @param talker TalkerId to set
	 */
	public GSVParser(TalkerId talker) {
		super(talker, SentenceId.GSV, 19);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#getSatelliteCount()
	 */
	public int getSatelliteCount() {
		return getIntValue(SATELLITES_IN_VIEW);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#getSatelliteInfo()
	 */
	public List getSatelliteInfo() {

		List satellites = new ArrayList(4);

		for (int idf : ID_FIELDS) {
			try {
				String id = getStringValue(idf);
				int elev = getIntValue(idf + ELEVATION);
				int azm = getIntValue(idf + AZIMUTH);
				int snr = getIntValue(idf + NOISE);
				satellites.add(new SatelliteInfo(id, elev, azm, snr));
			} catch (DataNotAvailableException e) {
				// nevermind missing satellite info
			} catch (IndexOutOfBoundsException e) {
				// less than four satellites, give up
				break;
			}
		}

		return satellites;
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#getSentenceCount()
	 */
	public int getSentenceCount() {
		return getIntValue(NUMBER_OF_SENTENCES);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#getSentenceIndex()
	 */
	public int getSentenceIndex() {
		return getIntValue(SENTENCE_NUMBER);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#isFirst()
	 */
	public boolean isFirst() {
		return (getSentenceIndex() == 1);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#isLast()
	 */
	public boolean isLast() {
		return (getSentenceIndex() == getSentenceCount());
	}

	public void setSatelliteCount(int count) {
		if (count < 0) {
			throw new IllegalArgumentException(
					"Satellite count cannot be negative");
		}
		setIntValue(SATELLITES_IN_VIEW, count);
	}

	/*
	 * (non-Javadoc)
	 * @see
	 * net.sf.marineapi.nmea.sentence.GSVSentence#setSatelliteInfo(java.util
	 * .List)
	 */
	public void setSatelliteInfo(List info) {
		if (info.size() > 4) {
			throw new IllegalArgumentException("Maximum list size is 4");
		}
		int i = 0;
		for (int id : ID_FIELDS) {
			if (i < info.size()) {
				SatelliteInfo si = info.get(i++);
				setStringValue(id, si.getId());
				setIntValue(id + ELEVATION, si.getElevation());
				setIntValue(id + AZIMUTH, si.getAzimuth(), 3);
				setIntValue(id + NOISE, si.getNoise());
			} else {
				setStringValue(id, "");
				setStringValue(id + ELEVATION, "");
				setStringValue(id + AZIMUTH, "");
				setStringValue(id + NOISE, "");
			}
		}
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#setSentenceCount(int)
	 */
	public void setSentenceCount(int count) {
		if (count < 1) {
			throw new IllegalArgumentException(
					"Number of sentences cannot be negative");
		}
		setIntValue(NUMBER_OF_SENTENCES, count);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.GSVSentence#setSentenceIndex(int)
	 */
	public void setSentenceIndex(int index) {
		if (index < 0) {
			throw new IllegalArgumentException(
					"Sentence index cannot be negative");
		}
		setIntValue(SENTENCE_NUMBER, index);
	}

}