net.sf.marineapi.nmea.sentence.VDRSentence 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!

/*
 * VDRSentence.java
 * Copyright (C) 2014 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;

/**
 * 
 * Set and drift, true/magnetic direction and speed of current.
 * 
 * 
 * Example:

 * 
 * 
 * 
 * @author Kimmo Tuukkanen
 */
public interface VDRSentence extends Sentence {

	/**
	 * Returns the magnetic current direction.
	 * 
	 * @return Direction in degrees
	 * @see #getTrueDirection()
	 */
	double getMagneticDirection();

	/**
	 * Returns the current flow speed.
	 * 
	 * @return Speed in knots
	 */
	double getSpeed();

	/**
	 * Returns the true direction of current.
	 * 
	 * @return Direction in degrees
	 * @see #getMagneticDirection()
	 */
	double getTrueDirection();

	/**
	 * Sets the magnetic direction of current.
	 * 
	 * @param direction
	 */
	void setMagneticDirection(double direction);

	/**
	 * Sets the current flow speed.
	 * 
	 * @param speed Speed in knots
	 */
	void setSpeed(double speed);

	/**
	 * Sets the true direction of current.
	 * 
	 * @param direction Direction in degrees
	 * @see #setMagneticDirection(double)
	 */
	void setTrueDirection(double direction);

}