ucar.unidata.geoloc.EarthLocation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdm Show documentation
The newest version!
/*
 * Copyright (c) 1998-2018 University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */
package ucar.unidata.geoloc;

import ucar.nc2.ft.PointFeature;

/**
 * A location on the earth, specified by lat, lon and optionally altitude.
 *
 * @author caron
 * @since Feb 18, 2008
 */
public interface EarthLocation {
  /**
   * Returns the latitude in some unit. The unit is very likely decimal degrees north, but we don't enforce that
   * anywhere.
   *
   * @return the latitude in some unit.
   */
  // FIXME: Enforce the "decimal degrees north" unit in EarthLocationImpl and other subclasses.
  // Or, allow a different unit and make it available from EarthLocation.
  double getLatitude();

  /**
   * Returns the longitude in some unit. The unit is very likely decimal degrees east, but we don't enforce that
   * anywhere.
   *
   * @return  the longitude in some unit.
   */
  // FIXME: Enforce the "decimal degrees east" unit in EarthLocationImpl and other subclasses.
  // Or, allow a different unit and make it available from EarthLocation.
  double getLongitude();

  /**
   * Returns the altitude in some unit. If this {@code EarthLocation} was retrieved from a {@link PointFeature}
   * (via {@link PointFeature#getLocation()}), then the unit can be obtained by calling
   * {@code pointFeature.getFeatureCollection().getAltUnits()}.
   *
   * @return  the altitude in some unit. A value of {@link Double#NaN} indicates "no altitude".
   */
  // FIXME: Make the unit available from EarthLocation.
  double getAltitude();

  /**
   * Get the lat/lon location
   * @return lat/lon location
   */
  LatLonPoint getLatLon();

  /**
   * Are either lat or lon missing?
   * @return true if lat or lon is missing
   */
  boolean isMissing();
}