ExifGpsPackage
Inheritance: java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
public final class ExifGpsPackage extends ExifDictionaryBasePackage
Represents GPS metadata in an EXIF metadata package.
Learn more
Constructors
| Constructor | Description |
|---|---|
| ExifGpsPackage() | Initializes a new instance of the ExifGpsPackage class. |
Methods
| Method | Description |
|---|---|
| getAltitude() | Gets the altitude based on the reference in AltitudeRef . |
| setAltitude(TiffRational value) | Sets the altitude based on the reference in AltitudeRef . |
| getAltitudeRef() | Gets the altitude used as the reference altitude. |
| setAltitudeRef(ExifGpsAltitudeRef value) | Sets the altitude used as the reference altitude. |
| getAreaInformation() | Gets the character string recording the name of the GPS area. |
| setAreaInformation(byte[] value) | Sets the character string recording the name of the GPS area. |
| getDateStamp() | Gets the character string recording date and time information relative to UTC (Coordinated Universal Time). |
| setDateStamp(String value) | Sets the character string recording date and time information relative to UTC (Coordinated Universal Time). |
| getDestBearing() | Gets the GPS bearing to the destination point. |
| setDestBearing(TiffRational value) | Sets the GPS bearing to the destination point. |
| getDestBearingRef() | Gets the GPS reference used for giving the bearing to the destination point. |
| setDestBearingRef(String value) | Sets the GPS reference used for giving the bearing to the destination point. |
| getDestDistance() | Gets the GPS distance to the destination point. |
| setDestDistance(TiffRational value) | Sets the GPS distance to the destination point. |
| getDestDistanceRef() | Gets the GPS unit used to express the distance to the destination point. |
| setDestDistanceRef(String value) | Sets the GPS unit used to express the distance to the destination point. |
| getDestLatitude() | Gets the GPS latitude of the destination point. |
| setDestLatitude(TiffRational[] value) | Sets the GPS latitude of the destination point. |
| getDestLatitudeRef() | Gets the GPS value which indicates whether the latitude of the destination point is north or south latitude. |
| setDestLatitudeRef(String value) | Sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. |
| getDestLongitude() | Gets the GPS longitude of the destination point. |
| setDestLongitude(TiffRational[] value) | Sets the GPS longitude of the destination point. |
| getDestLongitudeRef() | Gets the GPS value which indicates whether the longitude of the destination point is east or west longitude. |
| setDestLongitudeRef(String value) | Sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. |
| getDifferential() | Gets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| setDifferential(Integer value) | Sets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| getDataDegreeOfPrecision() | Gets the GPS DOP (data degree of precision). |
| setDataDegreeOfPrecision(TiffRational value) | Sets the GPS DOP (data degree of precision). |
| getImgDirection() | Gets the GPS direction of the image when it was captured. |
| setImgDirection(TiffRational value) | Sets the GPS direction of the image when it was captured. |
| getImgDirectionRef() | Gets the GPS reference for giving the direction of the image when it is captured. |
| setImgDirectionRef(String value) | Sets the GPS reference for giving the direction of the image when it is captured. |
| getLatitude() | Gets the GPS latitude. |
| setLatitude(TiffRational[] value) | Sets the GPS latitude. |
| getLatitudeRef() | Gets a GPS value indicating whether the latitude is north or south latitude. |
| setLatitudeRef(String value) | Sets a GPS value indicating whether the latitude is north or south latitude. |
| getLongitude() | Gets the GPS longitude. |
| setLongitude(TiffRational[] value) | Sets the GPS longitude. |
| getLongitudeRef() | Gets a GPS value indicating whether the longitude is east or west longitude. |
| setLongitudeRef(String value) | Sets a GPS value indicating whether the longitude is east or west longitude. |
| getMapDatum() | Gets the geodetic survey data used by the GPS receiver. |
| setMapDatum(String value) | Sets the geodetic survey data used by the GPS receiver. |
| getMeasureMode() | Gets the GPS measurement mode. |
| setMeasureMode(String value) | Sets the GPS measurement mode. |
| getProcessingMethod() | Gets a character string recording the name of the method used for location finding. |
| setProcessingMethod(byte[] value) | Sets a character string recording the name of the method used for location finding. |
| getSatellites() | Gets the GPS satellites used for measurements. |
| setSatellites(String value) | Sets the GPS satellites used for measurements. |
| getSpeed() | Gets the speed of GPS receiver movement. |
| setSpeed(TiffRational value) | Sets the speed of GPS receiver movement. |
| getSpeedRef() | Gets the unit used to express the GPS receiver speed of movement. |
| setSpeedRef(String value) | Sets the unit used to express the GPS receiver speed of movement. |
| getStatus() | Gets the status of the GPS receiver when the image is recorded. |
| setStatus(String value) | Sets the status of the GPS receiver when the image is recorded. |
| getTimeStamp() | Gets the time as UTC (Coordinated Universal Time). |
| setTimeStamp(TiffRational[] value) | Sets the time as UTC (Coordinated Universal Time). |
| getGpsTrack() | Gets the direction of GPS receiver movement. |
| setGpsTrack(TiffRational value) | Sets the direction of GPS receiver movement. |
| getTrackRef() | Gets the reference for giving the direction of GPS receiver movement. |
| setTrackRef(String value) | Sets the reference for giving the direction of GPS receiver movement. |
| getVersionID() | Gets the version of GPS IFD. |
| setVersionID(byte[] value) | Sets the version of GPS IFD. |
ExifGpsPackage()
public ExifGpsPackage()
Initializes a new instance of the ExifGpsPackage class.
getAltitude()
public final TiffRational getAltitude()
Gets the altitude based on the reference in AltitudeRef . The reference unit is meters.
Returns: TiffRational - The altitude based on the reference in AltitudeRef .
setAltitude(TiffRational value)
public final void setAltitude(TiffRational value)
Sets the altitude based on the reference in AltitudeRef . The reference unit is meters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The altitude based on the reference in AltitudeRef . |
getAltitudeRef()
public final ExifGpsAltitudeRef getAltitudeRef()
Gets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the Altitude tag.
Returns: ExifGpsAltitudeRef - The altitude used as the reference altitude
setAltitudeRef(ExifGpsAltitudeRef value)
public final void setAltitudeRef(ExifGpsAltitudeRef value)
Sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the Altitude tag.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ExifGpsAltitudeRef | The altitude used as the reference altitude |
getAreaInformation()
public final byte[] getAreaInformation()
Gets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.
Returns: byte[] - The character string recording the name of the GPS area.
setAreaInformation(byte[] value)
public final void setAreaInformation(byte[] value)
Sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] | The character string recording the name of the GPS area. |
getDateStamp()
public final String getDateStamp()
Gets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.
Returns: java.lang.String - The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.
setDateStamp(String value)
public final void setDateStamp(String value)
Sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD. |
getDestBearing()
public final TiffRational getDestBearing()
Gets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.
Returns: TiffRational - The bearing to the destination point.
setDestBearing(TiffRational value)
public final void setDestBearing(TiffRational value)
Sets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The bearing to the destination point. |
getDestBearingRef()
public final String getDestBearingRef()
Gets the GPS reference used for giving the bearing to the destination point. ‘T’ denotes true direction and ‘M’ is magnetic direction.
Returns: java.lang.String - The GPS reference used for giving the bearing to the destination point.
setDestBearingRef(String value)
public final void setDestBearingRef(String value)
Sets the GPS reference used for giving the bearing to the destination point. ‘T’ denotes true direction and ‘M’ is magnetic direction.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The GPS reference used for giving the bearing to the destination point. |
getDestDistance()
public final TiffRational getDestDistance()
Gets the GPS distance to the destination point.
Returns: TiffRational - The distance to the destination point.
setDestDistance(TiffRational value)
public final void setDestDistance(TiffRational value)
Sets the GPS distance to the destination point.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The distance to the destination point. |
getDestDistanceRef()
public final String getDestDistanceRef()
Gets the GPS unit used to express the distance to the destination point. ‘K’, ‘M’ and ‘N’ represent kilometers, miles and knots.
Returns: java.lang.String - The GPS unit used to express the distance to the destination point.
setDestDistanceRef(String value)
public final void setDestDistanceRef(String value)
Sets the GPS unit used to express the distance to the destination point. ‘K’, ‘M’ and ‘N’ represent kilometers, miles and knots.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The GPS unit used to express the distance to the destination point. |
getDestLatitude()
public final TiffRational[] getDestLatitude()
Gets the GPS latitude of the destination point.
Returns: com.groupdocs.metadata.core.TiffRational[] - The latitude of the destination point.
setDestLatitude(TiffRational[] value)
public final void setDestLatitude(TiffRational[] value)
Sets the GPS latitude of the destination point.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational[] | The latitude of the destination point. |
getDestLatitudeRef()
public final String getDestLatitudeRef()
Gets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value ‘N’ indicates north latitude, and ‘S’ is south latitude.
Returns: java.lang.String - The GPS value which indicates whether the latitude of the destination point is north or south latitude.
setDestLatitudeRef(String value)
public final void setDestLatitudeRef(String value)
Sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value ‘N’ indicates north latitude, and ‘S’ is south latitude.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The GPS value which indicates whether the latitude of the destination point is north or south latitude. |
getDestLongitude()
public final TiffRational[] getDestLongitude()
Gets the GPS longitude of the destination point.
Returns: com.groupdocs.metadata.core.TiffRational[] - The GPS longitude of the destination point.
setDestLongitude(TiffRational[] value)
public final void setDestLongitude(TiffRational[] value)
Sets the GPS longitude of the destination point.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational[] | The GPS longitude of the destination point. |
getDestLongitudeRef()
public final String getDestLongitudeRef()
Gets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII ‘E’ indicates east longitude, and ‘W’ is west longitude.
Returns: java.lang.String - The GPS value which indicates whether the longitude of the destination point is east or west longitude.
setDestLongitudeRef(String value)
public final void setDestLongitudeRef(String value)
Sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII ‘E’ indicates east longitude, and ‘W’ is west longitude.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The GPS value which indicates whether the longitude of the destination point is east or west longitude. |
getDifferential()
public final Integer getDifferential()
Gets a GPS value which indicates whether differential correction is applied to the GPS receiver.
Returns: java.lang.Integer - A GPS value which indicates whether differential correction is applied to the GPS receiver.
setDifferential(Integer value)
public final void setDifferential(Integer value)
Sets a GPS value which indicates whether differential correction is applied to the GPS receiver.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer | A GPS value which indicates whether differential correction is applied to the GPS receiver. |
getDataDegreeOfPrecision()
public final TiffRational getDataDegreeOfPrecision()
Gets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.
Returns: TiffRational - The data degree of precision.
setDataDegreeOfPrecision(TiffRational value)
public final void setDataDegreeOfPrecision(TiffRational value)
Sets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The data degree of precision. |
getImgDirection()
public final TiffRational getImgDirection()
Gets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.
Returns: TiffRational - The GPS direction of the image when it was captured.
setImgDirection(TiffRational value)
public final void setImgDirection(TiffRational value)
Sets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The GPS direction of the image when it was captured. |
getImgDirectionRef()
public final String getImgDirectionRef()
Gets the GPS reference for giving the direction of the image when it is captured. ‘T’ denotes true direction and ‘M’ is magnetic direction.
Returns: java.lang.String - The GPS reference for giving the direction of the image when it is captured.
setImgDirectionRef(String value)
public final void setImgDirectionRef(String value)
Sets the GPS reference for giving the direction of the image when it is captured. ‘T’ denotes true direction and ‘M’ is magnetic direction.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The GPS reference for giving the direction of the image when it is captured. |
getLatitude()
public final TiffRational[] getLatitude()
Gets the GPS latitude.
Returns: com.groupdocs.metadata.core.TiffRational[] - The latitude.
setLatitude(TiffRational[] value)
public final void setLatitude(TiffRational[] value)
Sets the GPS latitude.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational[] | The latitude. |
getLatitudeRef()
public final String getLatitudeRef()
Gets a GPS value indicating whether the latitude is north or south latitude.
Returns: java.lang.String - A GPS value indicating whether the latitude is north or south latitude.
setLatitudeRef(String value)
public final void setLatitudeRef(String value)
Sets a GPS value indicating whether the latitude is north or south latitude.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | A GPS value indicating whether the latitude is north or south latitude. |
getLongitude()
public final TiffRational[] getLongitude()
Gets the GPS longitude.
Returns: com.groupdocs.metadata.core.TiffRational[] - The longitude.
setLongitude(TiffRational[] value)
public final void setLongitude(TiffRational[] value)
Sets the GPS longitude.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational[] | The longitude. |
getLongitudeRef()
public final String getLongitudeRef()
Gets a GPS value indicating whether the longitude is east or west longitude.
Returns: java.lang.String - A GPS value indicating whether the longitude is east or west longitude.
setLongitudeRef(String value)
public final void setLongitudeRef(String value)
Sets a GPS value indicating whether the longitude is east or west longitude.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | A GPS value indicating whether the longitude is east or west longitude. |
getMapDatum()
public final String getMapDatum()
Gets the geodetic survey data used by the GPS receiver.
Returns: java.lang.String - The geodetic survey data used by the GPS receiver.
setMapDatum(String value)
public final void setMapDatum(String value)
Sets the geodetic survey data used by the GPS receiver.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The geodetic survey data used by the GPS receiver. |
getMeasureMode()
public final String getMeasureMode()
Gets the GPS measurement mode.
Returns: java.lang.String - The measure mode.
setMeasureMode(String value)
public final void setMeasureMode(String value)
Sets the GPS measurement mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The measure mode. |
getProcessingMethod()
public final byte[] getProcessingMethod()
Gets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.
Returns: byte[] - A character string recording the name of the method used for location finding.
setProcessingMethod(byte[] value)
public final void setProcessingMethod(byte[] value)
Sets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] | A character string recording the name of the method used for location finding. |
getSatellites()
public final String getSatellites()
Gets 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. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.
Returns: java.lang.String - The GPS satellites used for measurements.
setSatellites(String value)
public final void setSatellites(String value)
Sets 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. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The GPS satellites used for measurements. |
getSpeed()
public final TiffRational getSpeed()
Gets the speed of GPS receiver movement.
Returns: TiffRational - The speed of GPS receiver movement.
setSpeed(TiffRational value)
public final void setSpeed(TiffRational value)
Sets the speed of GPS receiver movement.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The speed of GPS receiver movement. |
getSpeedRef()
public final String getSpeedRef()
Gets the unit used to express the GPS receiver speed of movement. ‘K’ ‘M’ and ‘N’ represents kilometers per hour, miles per hour, and knots.
Returns: java.lang.String - The unit used to express the GPS receiver speed of movement.
setSpeedRef(String value)
public final void setSpeedRef(String value)
Sets the unit used to express the GPS receiver speed of movement. ‘K’ ‘M’ and ‘N’ represents kilometers per hour, miles per hour, and knots.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The unit used to express the GPS receiver speed of movement. |
getStatus()
public final String getStatus()
Gets the status of the GPS receiver when the image is recorded.
Returns: java.lang.String - The status of the GPS receiver when the image is recorded.
setStatus(String value)
public final void setStatus(String value)
Sets the status of the GPS receiver when the image is recorded.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The status of the GPS receiver when the image is recorded. |
getTimeStamp()
public final TiffRational[] getTimeStamp()
Gets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.
Returns: com.groupdocs.metadata.core.TiffRational[] - The time as UTC (Coordinated Universal Time).
setTimeStamp(TiffRational[] value)
public final void setTimeStamp(TiffRational[] value)
Sets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational[] | The time as UTC (Coordinated Universal Time). |
getGpsTrack()
public final TiffRational getGpsTrack()
Gets the direction of GPS receiver movement.
Returns: TiffRational - The direction of GPS receiver movement.
setGpsTrack(TiffRational value)
public final void setGpsTrack(TiffRational value)
Sets the direction of GPS receiver movement.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TiffRational | The direction of GPS receiver movement. |
getTrackRef()
public final String getTrackRef()
Gets the reference for giving the direction of GPS receiver movement. ‘T’ denotes true direction and ‘M’ is magnetic direction.
Returns: java.lang.String - The reference for giving the direction of GPS receiver movement.
setTrackRef(String value)
public final void setTrackRef(String value)
Sets the reference for giving the direction of GPS receiver movement. ‘T’ denotes true direction and ‘M’ is magnetic direction.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The reference for giving the direction of GPS receiver movement. |
getVersionID()
public final byte[] getVersionID()
Gets the version of GPS IFD.
Returns: byte[] - The version of GPS IFD
setVersionID(byte[] value)
public final void setVersionID(byte[] value)
Sets the version of GPS IFD.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] | The version of GPS IFD |