Package com.flir.thermalsdk.image

Class GpsInformation

java.lang.Object
com.flir.thermalsdk.image.GpsInformation
public final class GpsInformation extends Object
Defines a GPS information like latitude, longitude, etc..

  • Constructor Details

    • GpsInformation

      public GpsInformation(double latitude, double longitude)
      Creates a new instance of GPS information definition.
      Parameters:
      latitude - The latitude.
      longitude - The longitude.

    • GpsInformation

      public GpsInformation(double latitude, double longitude, float altitude, @NotNull @NotNull String latitudeRef, @NotNull @NotNull String longitudeRef, GpsInformation.AltitudeReference altitudeRef, float dop, @NotNull @NotNull String mapDatum, @NotNull @NotNull String satellites, @NotNull @NotNull Date timeStamp) throws IllegalArgumentException
      Creates a new instance of GPS information definition.
      Parameters:
      latitude - The latitude.
      longitude - The longitude.
      altitude - The altitude.
      latitudeRef - Latitude reference. Valid values are 'N' for the north latitude, and 'S' for the south latitude. May be left empty.
      longitudeRef - Longitude reference. Valid values are 'E' for the east longitude, and 'W' for the west longitude. May be left empty.
      altitudeRef - Altitude reference.
      dop - Gps DOP (data degree of precision).
      mapDatum - Map datum. Indicates the geodetic survey data used by the GPS receiver.
      satellites - The satellites. This tag can be used to describe the number of satellites, their ID number, etc.
      timeStamp - Indicates the time as UTC (Coordinated Universal Time).
      Throws:
      IllegalArgumentException - when the input values are not valid

  • Method Details

    • isValid

      public boolean isValid()
      A value indicating whether this GPS information is valid. Note: valid GPS data has at least non-zero latitude and longitude.

    • getDop

      public double getDop()
      Gps DOP (data degree of precision).

    • setDop

      public void setDop(float dop)
      Gps DOP (data degree of precision).

    • getAltitude

      public double getAltitude()
      The altitude. Note: If the altitude reference is below sea level, the altitude is indicated as an absolute value in altitude. The unit is meters.

    • setAltitude

      public void setAltitude(float altitude)
      The altitude. Note: If the altitude reference is below sea level, the altitude is indicated as an absolute value in altitude. The unit is meters.

    • getAltitudeRef

      public GpsInformation.AltitudeReference getAltitudeRef()
      Altitude reference indicates if the altitude value is below or above see level.

    • setAltitudeRef

      public void setAltitudeRef(GpsInformation.AltitudeReference altitudeRef)
      Altitude reference indicates if the altitude value is below or above see level.

    • getLatitude

      public double getLatitude()
      The latitude.

    • setLatitude

      public void setLatitude(double latitude)
      The latitude.

    • getLatitudeRef

      public String getLatitudeRef()
      Latitude reference.

      Indicates whether the latitude is north or south latitude. The value 'N' indicates north latitude, and 'S' is south latitude.

    • setLatitudeRef

      public void setLatitudeRef(@NotNull @NotNull String latitudeRef) throws IllegalArgumentException
      Latitude reference.

      Indicates whether the latitude is north or south latitude. Valid values are 'N' for the north latitude, and 'S' for the south latitude. Value can be also left empty if no information is available.

      Throws:
      IllegalArgumentException - when the input value is not valid

    • getLongitude

      public double getLongitude()
      The longitude.

    • setLongitude

      public void setLongitude(double longitude)
      The longitude.

    • getLongitudeRef

      public String getLongitudeRef()
      Longitude reference.

      Indicates whether the longitude is east or west longitude. The value 'E' indicates east longitude, and 'W' is west longitude.

    • setLongitudeRef

      public void setLongitudeRef(@NotNull @NotNull String longitudeRef) throws IllegalArgumentException
      Longitude reference.

      Indicates whether the longitude is east or west longitude. Valid values are 'E' for the east longitude, and 'W' for the west longitude. Value can be also left empty if no information is available.

      Throws:
      IllegalArgumentException - when the input value is not valid

    • getMapDatum

      public String getMapDatum()
      Map datum.

      Indicates the geodetic survey data used by the GPS receiver.

    • setMapDatum

      public void setMapDatum(@NotNull @NotNull String mapDatum)
      Map datum.

      Indicates the geodetic survey data used by the GPS receiver.

    • getSatellites

      public String getSatellites()
      The satellites.

      Indicates the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation.

    • setSatellites

      public void setSatellites(@NotNull @NotNull String satellites)
      The satellites.

      Indicates the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation.

    • getTimeStamp

      public Date getTimeStamp()
      The time.

      Indicates the time as UTC (Coordinated Universal Time).

    • setTimeStamp

      public void setTimeStamp(Date timeStamp)
      The time.

      Indicates the time as UTC (Coordinated Universal Time).

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object