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

/*
 * RPMSentence.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;

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

/**
 * Revolutions, measured from shaft or engine.
 * 
 * @author Kimmo Tuukkanen
 */
public interface RPMSentence extends Sentence {

	/** Source indicator for engine */
	public static final char ENGINE = 'E';
	
	/** Source indicator for shaft */
	public static final char SHAFT = 'S';

	/**
	 * Returns the engine or shaft number/id.
	 * 
	 * @return Engine of shaft number
	 */
	int getId();

	/**
	 * Returns the propeller pitch, % of maximum.
	 * 
	 * @return Pitch value, negative values denote astern.
	 */
	double getPitch();

	/**
	 * Returns the revolutions value.
	 * 
	 * @return Speed, revolutions per minute.
	 */
	double getRPM();

	/**
	 * Returns the measurement source, engine or shaft.
	 * 
	 * @return 'E' for engine, 'S' for shaft.
	 */
	char getSource();

	/**
	 * Returns the data validity status.
	 * 
	 * @return DataStatus
	 */
	DataStatus getStatus();

	/**
	 * Tells if the data source is engine.
	 * 
	 * @return True if engine, otherwise false.
	 */
	boolean isEngine();

	/**
	 * Tells if the data source is shaft.
	 * 
	 * @return True for shaft, otherwise false.
	 */
	boolean isShaft();

	/**
	 * Sets the engine or shaft number/id.
	 * 
	 * @param id ID to set.
	 */
	void setId(int id);

	/**
	 * Sets the propeller pitch, % of maximum.
	 * 
	 * @param pitch Pitch value to set, negative values denote astern.
	 */
	void setPitch(double pitch);

	/**
	 * Sets the source indicator, engine or shaft.
	 * 
	 * @param source 'E' for engine or 'S' for shaft.
	 * @throws IllegalArgumentException If specified char is not 'E' or 'S'.
	 */
	void setSource(char source);

	/**
	 * Sets the data validity status.
	 * 
	 * @param status DataStatus to set.
	 */
	void setStatus(DataStatus status);
}