net.sf.marineapi.nmea.util.GpsFixStatus 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!

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

/**
 * GpsFixStatus defines the status of current GPS fix.
 * 
 * @author Kimmo Tuukkanen
 * @see FaaMode
 * @see GpsFixQuality
 * @see DataStatus
 */
public enum GpsFixStatus {

	/** No GPS fix available */
	GPS_NA(1),
	/** 2D GPS fix (lat/lon) */
	GPS_2D(2),
	/** 3D GPS fix (lat/lon/alt) */
	GPS_3D(3);

	private final int status;

	GpsFixStatus(int intVal) {
		status = intVal;
	}

	/**
	 * Returns the corresponding int value for fix status enum.
	 * 
	 * @return Fix status integer values as in sentences
	 */
	public int toInt() {
		return status;
	}

	/**
	 * Returns the GpsFixStatus enum corresponding to actual int identifier used
	 * in the sentences.
	 * 
	 * @param val Fix status indentifier int
	 * @return GpsFixStatus enum
	 */
	public static GpsFixStatus valueOf(int val) {
		for (GpsFixStatus st : values()) {
			if (st.toInt() == val) {
				return st;
			}
		}
		return valueOf(String.valueOf(val));
	}
}