src.gov.nasa.worldwind.geom.coords.UPSCoord 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.avlist.AVKey;
import gov.nasa.worldwind.geom.Angle;
import gov.nasa.worldwind.globes.Globe;
import gov.nasa.worldwind.util.Logging;
/**
* This immutable class holds a set of UPS coordinates along with it's corresponding latitude and longitude.
*
* @author Patrick Murris
* @version $Id: UPSCoord.java 1171 2013-02-11 21:45:02Z dcollins $
*/
public class UPSCoord
{
private final Angle latitude;
private final Angle longitude;
private final String hemisphere;
private final double easting;
private final double northing;
/**
* Create a set of UPS coordinates from a pair of latitude and longitude for a WGS84 globe.
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
*
* @return the corresponding UPSCoord.
*
* @throws IllegalArgumentException if latitude or longitude is null, or the conversion to
* UPS coordinates fails.
*/
public static UPSCoord fromLatLon(Angle latitude, Angle longitude)
{
return fromLatLon(latitude, longitude, null);
}
/**
* Create a set of UPS coordinates from a pair of latitude and longitude for the given Globe.
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @param globe the Globe - can be null (will use WGS84).
*
* @return the corresponding UPSCoord.
*
* @throws IllegalArgumentException if latitude or longitude is null, or the conversion to
* UPS coordinates fails.
*/
public static UPSCoord fromLatLon(Angle latitude, Angle longitude, Globe globe)
{
if (latitude == null || longitude == null)
{
String message = Logging.getMessage("nullValue.LatitudeOrLongitudeIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
final UPSCoordConverter converter = new UPSCoordConverter(globe);
long err = converter.convertGeodeticToUPS(latitude.radians, longitude.radians);
if (err != UPSCoordConverter.UPS_NO_ERROR)
{
String message = Logging.getMessage("Coord.UPSConversionError");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
return new UPSCoord(latitude, longitude, converter.getHemisphere(),
converter.getEasting(), converter.getNorthing());
}
/**
* Create a set of UPS coordinates for a WGS84 globe.
*
* @param hemisphere the hemisphere, either {@link gov.nasa.worldwind.avlist.AVKey#NORTH} or {@link
* gov.nasa.worldwind.avlist.AVKey#SOUTH}.
* @param easting the easting distance in meters
* @param northing the northing distance in meters.
*
* @return the corresponding UPSCoord.
*
* @throws IllegalArgumentException if the conversion to UPS coordinates fails.
*/
public static UPSCoord fromUTM(String hemisphere, double easting, double northing)
{
return fromUPS(hemisphere, easting, northing, null);
}
/**
* Create a set of UPS coordinates for the given Globe.
*
* @param hemisphere the hemisphere, either {@link gov.nasa.worldwind.avlist.AVKey#NORTH} or {@link
* gov.nasa.worldwind.avlist.AVKey#SOUTH}.
* @param easting the easting distance in meters
* @param northing the northing distance in meters.
* @param globe the Globe - can be null (will use WGS84).
*
* @return the corresponding UPSCoord.
*
* @throws IllegalArgumentException if the conversion to UPS coordinates fails.
*/
public static UPSCoord fromUPS(String hemisphere, double easting, double northing, Globe globe)
{
final UPSCoordConverter converter = new UPSCoordConverter(globe);
long err = converter.convertUPSToGeodetic(hemisphere, easting, northing);
if (err != UTMCoordConverter.UTM_NO_ERROR)
{
String message = Logging.getMessage("Coord.UTMConversionError");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
return new UPSCoord(Angle.fromRadians(converter.getLatitude()),
Angle.fromRadians(converter.getLongitude()),
hemisphere, easting, northing);
}
/**
* Create an arbitrary set of UPS coordinates with the given values.
*
* @param latitude the latitude Angle.
* @param longitude the longitude Angle.
* @param hemisphere the hemisphere, either {@link gov.nasa.worldwind.avlist.AVKey#NORTH} or {@link
* gov.nasa.worldwind.avlist.AVKey#SOUTH}.
* @param easting the easting distance in meters
* @param northing the northing distance in meters.
*
* @throws IllegalArgumentException if latitude, longitude, or hemisphere is
* null.
*/
public UPSCoord(Angle latitude, Angle longitude, String hemisphere, double easting, double northing)
{
if (latitude == null || longitude == null)
{
String message = Logging.getMessage("nullValue.LatitudeOrLongitudeIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
this.latitude = latitude;
this.longitude = longitude;
this.hemisphere = hemisphere;
this.easting = easting;
this.northing = northing;
}
public Angle getLatitude()
{
return this.latitude;
}
public Angle getLongitude()
{
return this.longitude;
}
public String getHemisphere()
{
return this.hemisphere;
}
public double getEasting()
{
return this.easting;
}
public double getNorthing()
{
return this.northing;
}
public String toString()
{
StringBuilder sb = new StringBuilder();
sb.append(AVKey.NORTH.equals(hemisphere) ? "N" : "S");
sb.append(" ").append(easting).append("E");
sb.append(" ").append(northing).append("N");
return sb.toString();
}
}