nl.esi.metis.aisparser.AISMessage24PartB 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 AIS messages of type 24 Part B: Static data report.
 * @author Pierre van de Laar
 * @author Pierre America
 */
public interface AISMessage24PartB extends AISMessage24{

	/** 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  

	 * Not applicable to SAR aircraft
	 */
	public int getTypeOfShipAndCargoType();

	/** Returns the vendor ID. Currently there is not any utility class available to analyze this further.
	 * @return a BitVector representing the vendor ID (42 bits). 

	 * This is a unique identification of the transmitting unit by a number as defined by the manufacturer. 

	 * "@@@@@@@" = not available = default 

	 * See Table 76A in the standard Rec. ITU-R M.1371-4
	 */
	public BitVector getVendorID();

	/** Returns the call sign of the transmitting ship.
	 * @return a String value, containing up to 7 characters, representing the call sign 

	 * "" = not available
	 */
	public String getCallSign();

	/** Returns the dimensions of the ship and the reference point for position reporting,
	 * or for unregistered daughter vessels, the MMSI of the mother ship.
	 * Unfortunately, there is no reliable method to distinguish among these two possibilities.
	 * In case of dimensions, the value can be further analyzed using {@link UtilsDimensions30}.
	 * @return a BitVector object representing the dimensions or the mother ID (30 bits)
	 */
	public BitVector getDimensionOrMotherID();

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

}