src.gov.nasa.worldwind.geom.coords.MGRSCoord Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwindx Show documentation
Show all versions of worldwindx Show documentation
World Wind is a collection of components that interactively display 3D geographic information within Java applications or applets.
/*
* Copyright (C) 2012 United States Government as represented by the Administrator of the
* National Aeronautics and Space Administration.
* All Rights Reserved.
*/
package gov.nasa.worldwind.geom.coords;
import gov.nasa.worldwind.geom.Angle;
import gov.nasa.worldwind.globes.Globe;
import gov.nasa.worldwind.util.Logging;
/**
* This class holds an immutable MGRS coordinate string along with
* the corresponding latitude and longitude.
*
* @author Patrick Murris
* @version $Id: MGRSCoord.java 1171 2013-02-11 21:45:02Z dcollins $
*/
public class MGRSCoord
{
private final String MGRSString;
private final Angle latitude;
private final Angle longitude;
/**
* Create a WGS84 MGRS coordinate from a pair of latitude and longitude Angle
* with the maximum precision of five digits (one meter).
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @return the corresponding MGRSCoord.
* @throws IllegalArgumentException if latitude or longitude is null,
* or the conversion to MGRS coordinates fails.
*/
public static MGRSCoord fromLatLon(Angle latitude, Angle longitude)
{
return fromLatLon(latitude, longitude, null, 5);
}
/**
* Create a WGS84 MGRS coordinate from a pair of latitude and longitude Angle
* with the given precision or number of digits.
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @param precision the number of digits used for easting and northing (1 to 5).
* @return the corresponding MGRSCoord.
* @throws IllegalArgumentException if latitude or longitude is null,
* or the conversion to MGRS coordinates fails.
*/
public static MGRSCoord fromLatLon(Angle latitude, Angle longitude, int precision)
{
return fromLatLon(latitude, longitude, null, precision);
}
/**
* Create a MGRS coordinate from a pair of latitude and longitude Angle
* with the maximum precision of five digits (one meter).
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @param globe the Globe.
* @return the corresponding MGRSCoord.
* @throws IllegalArgumentException if latitude or longitude is null,
* the globe is null, or the conversion to MGRS coordinates fails.
*/
public static MGRSCoord fromLatLon(Angle latitude, Angle longitude, Globe globe)
{
return fromLatLon(latitude, longitude, globe, 5);
}
/**
* Create a MGRS coordinate from a pair of latitude and longitude Angle
* with the given precision or number of digits (1 to 5).
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @param globe the Globe - can be null (will use WGS84).
* @param precision the number of digits used for easting and northing (1 to 5).
* @return the corresponding MGRSCoord.
* @throws IllegalArgumentException if latitude or longitude is null,
* or the conversion to MGRS coordinates fails.
*/
public static MGRSCoord fromLatLon(Angle latitude, Angle longitude, Globe globe, int precision)
{
if (latitude == null || longitude == null)
{
String message = Logging.getMessage("nullValue.LatitudeOrLongitudeIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
final MGRSCoordConverter converter = new MGRSCoordConverter(globe);
long err = converter.convertGeodeticToMGRS(latitude.radians, longitude.radians, precision);
if (err != MGRSCoordConverter.MGRS_NO_ERROR)
{
String message = Logging.getMessage("Coord.MGRSConversionError");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
return new MGRSCoord(latitude, longitude, converter.getMGRSString());
}
/**
* Create a MGRS coordinate from a standard MGRS coordinate text string.
*
* The string will be converted to uppercase and stripped of all spaces before being evaluated.
*
* Valid examples:
* 32TLP5626635418
* 32 T LP 56266 35418
* 11S KU 528 111
*
* @param MGRSString the MGRS coordinate text string.
* @param globe the Globe - can be null (will use WGS84).
* @return the corresponding MGRSCoord.
* @throws IllegalArgumentException if the MGRSString is null or empty,
* the globe is null, or the conversion to geodetic coordinates fails (invalid coordinate string).
*/
public static MGRSCoord fromString(String MGRSString, Globe globe)
{
if (MGRSString == null || MGRSString.length() == 0)
{
String message = Logging.getMessage("nullValue.StringIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
MGRSString = MGRSString.toUpperCase().replaceAll(" ", "");
final MGRSCoordConverter converter = new MGRSCoordConverter(globe);
long err = converter.convertMGRSToGeodetic(MGRSString);
if (err != MGRSCoordConverter.MGRS_NO_ERROR)
{
String message = Logging.getMessage("Coord.MGRSConversionError");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
return new MGRSCoord(Angle.fromRadians(converter.getLatitude()), Angle.fromRadians(converter.getLongitude()), MGRSString);
}
/**
* Create an arbitrary MGRS coordinate from a pair of latitude-longitude Angle
* and the corresponding MGRS coordinate string.
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @param MGRSString the corresponding MGRS coordinate string.
* @throws IllegalArgumentException if latitude or longitude is null,
* or the MGRSString is null or empty.
*/
public MGRSCoord(Angle latitude, Angle longitude, String MGRSString)
{
if (latitude == null || longitude == null)
{
String message = Logging.getMessage("nullValue.LatitudeOrLongitudeIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (MGRSString == null)
{
String message = Logging.getMessage("nullValue.StringIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (MGRSString.length() == 0)
{
String message = Logging.getMessage("generic.StringIsEmpty");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.latitude = latitude;
this.longitude = longitude;
this.MGRSString = MGRSString;
}
public Angle getLatitude()
{
return this.latitude;
}
public Angle getLongitude()
{
return this.longitude;
}
public String toString()
{
return this.MGRSString;
}
}