net.sf.marineapi.nmea.parser.DBTParser 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!
/* 
 * DBTParser.java
 * Copyright (C) 2011 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 net.sf.marineapi.nmea.sentence.DBTSentence;
import net.sf.marineapi.nmea.sentence.SentenceId;
import net.sf.marineapi.nmea.sentence.TalkerId;
import net.sf.marineapi.nmea.util.Units;

/**
 * DBT sentence parser.
 * 
 * @author Kimmo Tuukkanen
 */
class DBTParser extends SentenceParser implements DBTSentence {

	// TODO calculate value for all units when setting a value

	private static final int DEPTH_FEET = 0;
	private static final int FEET = 1;
	private static final int DEPTH_METERS = 2;
	private static final int METERS = 3;
	private static final int DEPTH_FATHOMS = 4;
	private static final int FATHOMS = 5;

	/**
	 * Creates a new instance of DBTParser.
	 * 
	 * @param nmea
	 */
	public DBTParser(String nmea) {
		super(nmea, SentenceId.DBT);
	}

	/**
	 * Creates a new instance of DBTParser with empty data fields.
	 * 
	 * @param talker TalkerId to set
	 */
	public DBTParser(TalkerId talker) {
		super(talker, SentenceId.DBT, 6);
		setCharValue(FEET, Units.FEET.toChar());
		setCharValue(METERS, Units.METER.toChar());
		setCharValue(FATHOMS, Units.FATHOMS.toChar());
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.DBTSentence#getMeters()
	 */
	public double getDepth() {
		return getDoubleValue(DEPTH_METERS);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.DBTSentence#getFathoms()
	 */
	public double getFathoms() {
		return getDoubleValue(DEPTH_FATHOMS);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.DBTSentence#getFeet()
	 */
	public double getFeet() {
		return getDoubleValue(DEPTH_FEET);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.DBTSentence#setMeters(double)
	 */
	public void setDepth(double depth) {
		setDoubleValue(DEPTH_METERS, depth, 1, 1);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.DBTSentence#setFathoms(double)
	 */
	public void setFathoms(double depth) {
		setDoubleValue(DEPTH_FATHOMS, depth, 1, 1);
	}

	/*
	 * (non-Javadoc)
	 * @see net.sf.marineapi.nmea.sentence.DBTSentence#setFeet(double)
	 */
	public void setFeet(double depth) {
		setDoubleValue(DEPTH_FEET, depth, 1, 1);
	}
}