net.sf.marineapi.nmea.sentence.RTESentence 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!
/* 
 * RTESentence.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.RouteType;

/**
 * GPS route data and list of waypoints.
 * 
 * Example:

 * $GPRTE,1,1,c,0,MELIN,RUSKI,KNUDAN*25
 * 
 * @author Kimmo Tuukkanen
 */
public interface RTESentence extends Sentence {

	/**
	 * Add a waypoint ID at the end of waypoint list. The number of waypoint id
	 * fields is increased by one on each addition.
	 * 
	 * @param id Waypoint ID to add.
	 * @return The total number of waypoint IDs after addition.
	 */
	int addWaypointId(String id);

	/**
	 * Get the number or name of the route.
	 * 
	 * @return Route ID or name as String
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If the field contains
	 *             unexpected or illegal value.
	 */
	String getRouteId();

	/**
	 * Get the number of sentences in RTE sequence.
	 * 
	 * @return integer
	 * @see #getSentenceIndex()
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If the field contains
	 *             unexpected or illegal value.
	 */
	int getSentenceCount();

	/**
	 * Get the index of sentence in RTE sequence.
	 * 
	 * @return integer
	 * @see #getSentenceCount()
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If the field contains
	 *             unexpected or illegal value.
	 */
	int getSentenceIndex();

	/**
	 * Get the number of waypoints IDs in this sentence.
	 * 
	 * @return Waypoint count
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If the field contains
	 *             unexpected or illegal value.
	 */
	int getWaypointCount();

	/**
	 * Get the list of route waypoints.
	 * 
	 * @return Waypoint IDs as String array
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If the field contains
	 *             unexpected or illegal value.
	 */
	String[] getWaypointIds();

	/**
	 * Tells if the sentence holds a current active route data.
	 * 
	 * @return true if active route, otherwise false.
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If the field contains
	 *             unexpected or illegal value.
	 */
	boolean isActiveRoute();

	/**
	 * Tells if this is the first sentence in RTE sequence.
	 * 
	 * @return true if there's no sentences left, otherwise false.
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the sentence
	 *             index or sentence count is not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If sentence index or count
	 *             fields contain unexpected or illegal value.
	 */
	boolean isFirst();

	/**
	 * Tells if this is the last sentence in RTE sequence.
	 * 
	 * @return true if there's no sentences left, otherwise false.
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the sentence
	 *             index or sentence count is not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If sentence index or count
	 *             fields contain unexpected or illegal value.
	 */
	boolean isLast();

	/**
	 * Tells if the sentence holds a current working route data.
	 * 
	 * @return true if working route, otherwise false.
	 * @throws net.sf.marineapi.nmea.parser.DataNotAvailableException If the data is
	 *             not available.
	 * @throws net.sf.marineapi.nmea.parser.ParseException If status field contains
	 *             illegal value.
	 */
	boolean isWorkingRoute();

	/**
	 * Set the route name or number.
	 * 
	 * @param id Route ID or name as String
	 */
	void setRouteId(String id);

	/**
	 * Set the type of route.
	 * 
	 * @param type RouteType to set
	 */
	void setRouteType(RouteType type);

	/**
	 * Set the number of sentences in RTE sequence.
	 * 
	 * @param count Sentence count in sequence
	 * @throws IllegalArgumentException If the specified count is negative.
	 */
	void setSentenceCount(int count);

	/**
	 * Set the index of sentence in RTE sequence.
	 * 
	 * @param index Sentence index in sequence
	 * @throws IllegalArgumentException If specified index is negative.
	 */
	void setSentenceIndex(int index);

	/**
	 * Set the list of route waypoints.
	 * 
	 * @param ids String array of waypoint IDs
	 */
	void setWaypointIds(String[] ids);

}