nl.esi.metis.aisparser.AISMessageUTCReport 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;

/** This is the common interface for all types of AIS messages that provide UTC time and position reports. 
 * Such messages can be transmitted both by mobile stations (i.e., ships and other vehicles) and by base stations.
 * @author Pierre van de Laar
 * @author Pierre America
 */
public interface AISMessageUTCReport extends AISMessage, PositionInfo{

	/** Returns the UTC year.
	 * @return an integer value representing the UTC year (1-9999) 

	 * 0 = UTC year not available
	 */
	public int getUtcYear();

	/** Returns the UTC month.
	 * @return an integer value representing the UTC month (1-12) 

	 * 0 = UTC month not available 

	 * 13-15 not used
	 */
	public int getUtcMonth();

	/** Returns the UTC day.
	 * @return an integer value representing the UTC day (1-31) 

	 * 0 = UTC day not available
	 */
	public int getUtcDay();

	/** Returns the UTC hour.
	 * @return an integer value representing the UTC hour (0-23) 

	 * 24 = UTC hour not available 

	 * 25-31 not used
	 */
	public int getUtcHour();

	/** Returns the UTC minute.
	 * @return an integer value representing the UTC minute (0-59) 

	 * 60 = UTC minute not available 

	 * 61-63 not used
	 */
	public int getUtcMinute();

	/** Returns the UTC second.
	 * @return an integer value representing the UTC second (0-59) 

	 * 60 = UTC second not available 

	 * 61-63 not used
	 */
	public int getUtcSecond();

	/** 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 transmission control for long range broadcast message.
	 * @return a boolean value: 

	 * false = default: Class-A AIS station stops transmission of Message 27 within an AIS base station coverage area. 

	 * true = Request Class-A station to transmit Message 27 within an AIS base station coverage area.
	 */
	public boolean getTransmissionControlForLongRangeBroadcastMessage();

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

	/** Returns the RAIM flag, which describes the receiver autonomous integrity monitoring status of the electronic position fixing device.
	 * @return a boolean value: 

	 * false = RAIM not in use 

	 * true = RAIM in use
	 */
	public boolean getRaimFlag();

	/** Returns the communication state.
	 * @return the SOTDMA value of the communication state.
	 */
	public Sotdma getCommunicationState();

}