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

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

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

/**
 * Common interface for sentences that contain geographic position.
 * 
 * @author Kimmo Tuukkanen
 */
public interface PositionSentence extends Sentence {

	/**
	 * Gets the geographic position.
	 * 
	 * @return Position
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If any of the
	 *             position related fields is empty.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If any of the position
	 *             related fields contains unexpected value.
	 */
	Position getPosition();

	/**
	 * Set the geographic position.
	 * 
	 * @param pos Position to set
	 */
	void setPosition(Position pos);
}