Cartographic

java.lang.Object
- agi.foundation.coordinates.Cartographic

All Implemented Interfaces:

IEquatable<Cartographic>, ImmutableValueType, ValueType, IEquatableEpsilon<Cartographic>
```
public final class Cartographic
extends Object
implements IEquatable<Cartographic>, IEquatableEpsilon<Cartographic>, ImmutableValueType
```
A set of curvilinear 3-dimensional coordinates.

Constructor Summary

Constructors
Constructor and Description
`Cartographic()` Initializes a new instance.
`Cartographic(double[] elements)` Initializes a set of `Cartographic` coordinates from the first 3 consecutive elements in the provided array.
`Cartographic(double[] elements, int startIndex)` Initializes a set of `Cartographic` coordinates from the provided array.
`Cartographic(double longitude, double latitude, double height)` Initializes a set of `Cartographic` coordinates from the provided values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`equals(Cartographic left, Cartographic right)` Returns `true` if the two instances are exactly equal.
`boolean`	`equals(Object obj)` Indicates whether another object is exactly equal to this instance.
`boolean`	`equalsEpsilon(Cartographic 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(Cartographic other)` Indicates whether another instance of this type is exactly equal to this instance.
`double`	`get(int index)` Gets the value of the specified element with `index` of 0, 1, and 2 corresponding to the coordinates `Longitude` (`get`), `Latitude` (`get`), and `Height` (`get`).
`double`	`getHeight()` Gets the linear coordinate measured perpendicular to the surface of the ellipsoid and positive above the surface.
`boolean`	`getIsUndefined()` Gets a value indicating whether or not any of the coordinates for this instance have the value `Double.NaN`.
`double`	`getLatitude()` Gets the angular coordinate measured perpendicular to the equatorial plane.
`int`	`getLength()` Gets the number of elements in this set of coordinates.
`double`	`getLongitude()` Gets the angular coordinate lying in the equatorial plane of the ellipsoid and measured from the prime meridian.
`static Cartographic`	`getUndefined()` Gets a set of `Cartographic` coordinates with values of `Double.NaN`.
`static Cartographic`	`getZero()` Gets a set of `Cartographic` coordinates representing the zero vector.
`int`	`hashCode()` Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
`boolean`	`isAtPole()` Indicates whether the absolute value of the `Latitude` (`get`) equals `Constants.HalfPi`.
`boolean`	`isAtPole(double epsilon)` Indicates whether the absolute value of the `Latitude` (`get`) equals `Constants.HalfPi` within the provided tolerance.
`boolean`	`isEquivalent(Cartographic other)` Indicates whether another instance of this type is mathematically equivalent to this instance.
`boolean`	`isEquivalent(Cartographic other, double epsilon)` Indicates whether another instance of this type is mathematically equivalent to this instance, within the required tolerance.
`static boolean`	`notEquals(Cartographic left, Cartographic 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
  - Cartographic
```
public Cartographic()
```
    Initializes a new instance.
  - Cartographic
```
public Cartographic(double longitude,
                    double latitude,
                    double height)
```
    Initializes a set of Cartographic coordinates from the provided values.
    
    Parameters:
    
    longitude - The angular coordinate lying in the equatorial plane of the ellipsoid and measured from the prime meridian.
    
    latitude - The angular coordinate measured perpendicular to the equatorial plane.
    
    height - The linear coordinate measured perpendicular to the surface of the ellipsoid and positive above the surface.
  - Cartographic
```
public Cartographic(@Nonnull
                    double[] elements)
```
    Initializes a set of Cartographic coordinates from the first 3 consecutive elements in the provided array.
    
    Parameters:
    
    elements - The array of coordinate values.
    
    Throws:
    
    ArgumentNullException - Thrown when elements is null.
    
    ArgumentOutOfRangeException - An object of this type must be constructed from an array with at least 3 elements.
  - Cartographic
```
public Cartographic(@Nonnull
                    double[] elements,
                    int startIndex)
```
    Initializes a set of Cartographic coordinates from the provided array.
    
    Parameters:
    
    elements - The array of coordinate values.
    
    startIndex - The index of the first element in the array to use.
    
    Throws:
    
    ArgumentNullException - Thrown when elements is null.
    
    ArgumentOutOfRangeException - Thrown when an object of this type is constructed from an array with less than 3 elements.
- Method Detail
  - getZero
```
@Nonnull
public static Cartographic getZero()
```
    Gets a set of Cartographic coordinates representing the zero vector.
  - getUndefined
```
@Nonnull
public static Cartographic getUndefined()
```
    Gets a set of Cartographic coordinates with values of Double.NaN.
    Use IsUndefined (get) to test whether a Cartographic instance is undefined since it will return true if any of the coordinate values are Double.NaN.
  - getLongitude
```
public final double getLongitude()
```
    Gets the angular coordinate lying in the equatorial plane of the ellipsoid and measured from the prime meridian.
  - getLatitude
```
public final double getLatitude()
```
    Gets the angular coordinate measured perpendicular to the equatorial plane.
  - getHeight
```
public final double getHeight()
```
    Gets the linear coordinate measured perpendicular to the surface of the ellipsoid and positive above the surface.
  - getLength
```
public final int getLength()
```
    Gets the number of elements in this set of coordinates.
  - getIsUndefined
```
public final boolean getIsUndefined()
```
    Gets a value indicating whether or not any of the coordinates for this instance have the value Double.NaN.
  - isAtPole
```
public final boolean isAtPole()
```
    Indicates whether the absolute value of the Latitude (get) equals Constants.HalfPi.
    
    Returns:
    
    true if this point is at the pole; otherwise false.
  - isAtPole
```
public final boolean isAtPole(double epsilon)
```
    Indicates whether the absolute value of the Latitude (get) equals Constants.HalfPi within the provided tolerance.
    
    Parameters:
    
    epsilon - The tolerance for the comparison.
    
    Returns:
    
    true if this point is at the pole, within tolerance; otherwise false.
  - get
```
public final double get(int index)
```
    Gets the value of the specified element with index of 0, 1, and 2 corresponding to the coordinates Longitude (get), Latitude (get), and Height (get).
    
    Parameters:
    
    index - The index to retrieve.
    
    Returns:
    
    The coordinate associated with the specified index.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when index is less than 0 or greater than or equal to Length (get).
  - 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
                                Cartographic other)
```
    Indicates whether another instance of this type is exactly equal to this instance.
    This method performs a strict comparison of each coordinate value. Consider using Cartographic.isEquivalent(agi.foundation.coordinates.Cartographic) to account for longitude ambiguity for points at the poles.
    
    Specified by:
    
    equalsType in interface IEquatable<Cartographic>
    
    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
                                   Cartographic 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.
    This method performs a strict comparison of each coordinate value relative to the specified tolerance. Consider using Cartographic.isEquivalent(agi.foundation.coordinates.Cartographic,double) to account for longitude ambiguity for points near the poles.
    
    Specified by:
    
    equalsEpsilon in interface IEquatableEpsilon<Cartographic>
    
    Parameters:
    
    other - The set of Cartographic 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.
  - isEquivalent
```
public final boolean isEquivalent(@Nonnull
                                  Cartographic other)
```
    Indicates whether another instance of this type is mathematically equivalent to this instance. Instances are equivalent if each coordinate value of one instance is equal to the corresponding coordinate value of the other instance, or if both points are at the same pole.
    
    Parameters:
    
    other - The set of Cartographic coordinates to compare to this instance.
    
    Returns:
    
    true if they are equivalent; otherwise false.
  - isEquivalent
```
public final boolean isEquivalent(@Nonnull
                                  Cartographic other,
                                  double epsilon)
```
    Indicates whether another instance of this type is mathematically equivalent to this instance, within the required tolerance. Instances are equivalent if each coordinate value of one instance is equal to the corresponding coordinate value of the other instance, or if both points are at the same pole.
    
    Parameters:
    
    other - The set of Cartographic 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 they are equivalent; 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 "Longitude, Latitude, Height".
  - equals
```
public static boolean equals(@Nonnull
                             Cartographic left,
                             @Nonnull
                             Cartographic 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
                                Cartographic left,
                                @Nonnull
                                Cartographic 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.

Class Cartographic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cartographic

Cartographic

Cartographic

Method Detail

getZero

getUndefined

getLongitude

getLatitude

getHeight

getLength

getIsUndefined

isAtPole

isAtPole

get

equals

equalsType

equalsEpsilon

isEquivalent

isEquivalent

hashCode

toString

equals

notEquals