agi.foundation.coordinates

(agi.foundation.core-2024r3.jar)

Class UniversalPolarStereographic

java.lang.Object

agi.foundation.coordinates.UniversalPolarStereographic

All Implemented Interfaces:

IEquatable<UniversalPolarStereographic>, ImmutableValueType, ValueType, IEquatableEpsilon<UniversalPolarStereographic>

public final class UniversalPolarStereographic
extends Object
implements IEquatable<UniversalPolarStereographic>, IEquatableEpsilon<UniversalPolarStereographic>, ImmutableValueType

A set of coordinates for specifying locations near the poles of the Earth based on a grid as outlined in Defense Mapping Agency Technical Manual (DMA TM) 8358.2, "The Universal Grids: Universal Transverse Mercator (UTM) and Universal Polar Stereographic (UPS)", Edition 1, 18 September 1989.

See Also:

MilitaryGridReferenceSystem, UniversalTransverseMercator

Constructor Summary

Constructors

Constructor and Description
UniversalPolarStereographic() Initializes a new instance.
UniversalPolarStereographic(PoleIndicator hemisphere, double easting, double northing) Initializes a set of UniversalPolarStereographic coordinates from the provided values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(UniversalPolarStereographic left, UniversalPolarStereographic right) Returns true if the two instances are exactly equal.
boolean	equalsEpsilon(UniversalPolarStereographic other, double epsilon) Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
boolean	equalsType(UniversalPolarStereographic other) Indicates whether another instance of this type is exactly equal to this instance.
double	getEasting() Gets the eastward distance of the location into the zone.
PoleIndicator	getHemisphere() Gets the hemisphere of the coordinates.
boolean	getIsUndefined() Gets a value indicating whether or not the Easting (get) and Northing (get) coordinates for this instance have the value Double.NaN or the Hemisphere (get) is invalid.
double	getNorthing() Gets the northward distance of the location into the zone.
static UniversalPolarStereographic	getUndefined() Gets a set of UniversalPolarStereographic coordinates with Easting (get) and Northing (get) values of Double.NaN and Hemisphere (get) 0.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(UniversalPolarStereographic left, UniversalPolarStereographic right) Returns true if the two instances are not exactly equal.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UniversalPolarStereographic

public UniversalPolarStereographic()

Initializes a new instance.

UniversalPolarStereographic

public UniversalPolarStereographic(@Nonnull
                                   PoleIndicator hemisphere,
                                   double easting,
                                   double northing)

Initializes a set of UniversalPolarStereographic coordinates from the provided values.

Parameters:

hemisphere - The hemisphere indicator.

easting - The eastward distance of the location into the zone.

northing - The northward distance of the location into the zone.

Method Detail

getUndefined

@Nonnull
public static UniversalPolarStereographic getUndefined()

Gets a set of UniversalPolarStereographic coordinates with Easting (get) and Northing (get) values of Double.NaN and Hemisphere (get) 0.

Use IsUndefined (get) to test whether a UniversalPolarStereographic instance is undefined since it will return true if the Easting (get) or Northing (get) values are Double.NaN or the Hemisphere (get) is invalid.

getHemisphere

@Nonnull
public final PoleIndicator getHemisphere()

Gets the hemisphere of the coordinates.

getEasting

public final double getEasting()

Gets the eastward distance of the location into the zone.

getNorthing

public final double getNorthing()

Gets the northward distance of the location into the zone.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                UniversalPolarStereographic other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<UniversalPolarStereographic>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equalsEpsilon

public final boolean equalsEpsilon(@Nonnull
                                   UniversalPolarStereographic other,
                                   double epsilon)

Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<UniversalPolarStereographic>

Parameters:

other - The set of UniversalPolarStereographic coordinates to compare to this instance.

epsilon - The limit at which the absolute differences between the coordinate values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form "Hemisphere, Easting, Northing".

equals

public static boolean equals(@Nonnull
                             UniversalPolarStereographic left,
                             @Nonnull
                             UniversalPolarStereographic right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                UniversalPolarStereographic left,
                                @Nonnull
                                UniversalPolarStereographic right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

getIsUndefined

public final boolean getIsUndefined()

Gets a value indicating whether or not the Easting (get) and Northing (get) coordinates for this instance have the value Double.NaN or the Hemisphere (get) is invalid.