nl.esi.metis.aisparser.AISMessage19 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of EsiAisParser Show documentation

This package supports the parsing of AIS messages in Java. AIS, the Automatic Identification System, is a system aiming at improving maritime safety by exchanging messages between ships, other vehicles in particular aircraft involved in search-and-rescue (SAR), and (fixed) base stations. To be precise, this package support the ITU-R M.1371-4 AIS standard. See our extensive javadoc and in particular the class AISParser for more information on how to use this package. The parser was used in the Poseidon project, and is improved in the Metis project to better handle uncertain information. Both projects were led by the Embedded Systems Institute. In both projects Thales Nederlands was the carrying industrial partner, and multiple Dutch universities participated.

The newest version!

/* ESI AIS Parser
 * 
 * Copyright 2011/2012 by Pierre van de Laar & Pierre America (Embedded Systems Institute)
 * Copyright 2008 by Brian C. Lane 
 * All Rights Reserved
 * 
 */
package nl.esi.metis.aisparser;

import cern.colt.bitvector.BitVector;

/** This interface represents an AIS message of type 19: Extended Class B Equipment Position Report.
*
* @author Pierre van de Laar
* @author Pierre America
* @author Brian C. Lane
*/
public interface AISMessage19 extends AISMessageClassBPositionReport {

	/** Returns the name of the transmitting ship.
	 * @return a String value, containing maximum 20 characters, representing the name. 

	 * "" = not available.
	 */
	public String getName();

	/** Returns the type of ship and cargo type. 
	 * This can be converted to a String by utility class {@link UtilsShipType8}.
	 * @return an integer value representing the type of ship and cargo type: 

	 * 0 = not available or no ship 

	 * 1-99 = as defined in the standard (see {@link UtilsShipType8}) 

	 * 100-199 = reserved for regional use 

	 * 200-255 = reserved for future use  

	 */
	public int getTypeOfShipAndCargoType();

	/** Returns the dimensions of the ship and the reference point for the reported position.
	 * These can be analyzed further with utility class {@link UtilsDimensions30}.
	 * @return a BitVector value representing the dimensions.
	 */
	public BitVector getDimension();

	/** Returns the type of electronic position fixing device.
	 * @return an integer value representing of the type of electronic position fixing device: 

	 * 0 = undefined (default) 

	 * 1 = global positioning system (GPS) 

	 * 2 = GNSS (GLONASS) 

	 * 3 = combined GPS/GLONASS 

	 * 4 = Loran-C 

	 * 5 = Chayka 

	 * 6 = integrated navigation system 

	 * 7 = surveyed 

	 * 8 = Galileo 

	 * 9-14 = not used 

	 * 15 = internal GNSS
	 */
	public int getTypeOfElectronicPositionFixingDevice();

	/** Returns the data terminal equipment (DTE) status.
	 * @return a boolean value describing whether the data terminal equipment is ready: 

	 * false = available 

	 * true = not available
	 */
	public boolean getDte();

	/** Returns the third set of spare bits.
	 * @return the value of the third set of spare bits. This should be zero.
	 */
	public int getSpare3();

}