agi.foundation.coordinates

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

Class AzimuthHorizontalVertical

java.lang.Object

agi.foundation.coordinates.AzimuthHorizontalVertical

All Implemented Interfaces:

IEquatable<AzimuthHorizontalVertical>, ImmutableValueType, ValueType, IEquatableEpsilon<AzimuthHorizontalVertical>

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

A set of curvilinear 3-dimensional coordinates.

The Azimuth (get) is the angular coordinate lying in the local horizontal plane from the Northerly direction to the Easterly direction. The Horizontal (get) is the linear coordinate measured in the local horizontal plane. The Vertical (get) is linear coordinate measured perpendicular to the local horizontal plane.

Constructor Summary

Constructors

Constructor and Description
AzimuthHorizontalVertical() Initializes a new instance.
AzimuthHorizontalVertical(double[] elements) Initializes a set of AzimuthHorizontalVertical coordinates from the first 3 consecutive elements in the provided array.
AzimuthHorizontalVertical(double[] elements, int startIndex) Initializes a set of AzimuthHorizontalVertical coordinates from the provided array.
AzimuthHorizontalVertical(double azimuth, double horizontal, double vertical) Initializes a set of AzimuthHorizontalVertical coordinates from the provided values.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(AzimuthHorizontalVertical left, AzimuthHorizontalVertical 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(AzimuthHorizontalVertical 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(AzimuthHorizontalVertical 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 Azimuth (get), Horizontal (get), and Vertical (get).
double	getAzimuth() Gets the angular coordinate lying in the local horizontal plane from the Northerly direction to the Easterly direction.
double	getHorizontal() Gets the linear coordinate measured in the local horizontal plane.
int	getLength() Gets the number of elements in this set of coordinates.
double	getVertical() Gets the linear coordinate measured perpendicular to the local horizontal plane.
static AzimuthHorizontalVertical	getZero() Gets a set of AzimuthHorizontalVertical coordinates with values of zero.
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(AzimuthHorizontalVertical left, AzimuthHorizontalVertical 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

AzimuthHorizontalVertical

public AzimuthHorizontalVertical()

Initializes a new instance.

AzimuthHorizontalVertical

public AzimuthHorizontalVertical(double azimuth,
                                 double horizontal,
                                 double vertical)

Initializes a set of AzimuthHorizontalVertical coordinates from the provided values.

Parameters:

azimuth - The angular coordinate lying in the local horizontal plane from the Northerly direction to the Easterly direction.

horizontal - The linear coordinate measured in the local horizontal plane.

vertical - The linear coordinate measured perpendicular to the local horizontal plane.

AzimuthHorizontalVertical

public AzimuthHorizontalVertical(@Nonnull
                                 double[] elements)

Initializes a set of AzimuthHorizontalVertical coordinates from the first 3 consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values ordered consecutively as azimuth, horizontal, vertical.

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.

AzimuthHorizontalVertical

public AzimuthHorizontalVertical(@Nonnull
                                 double[] elements,
                                 int startIndex)

Initializes a set of AzimuthHorizontalVertical coordinates from the provided array.

Parameters:

elements - The array of coordinate values ordered consecutively as azimuth, horizontal, vertical.

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 AzimuthHorizontalVertical getZero()

Gets a set of AzimuthHorizontalVertical coordinates with values of zero.

getAzimuth

public final double getAzimuth()

Gets the angular coordinate lying in the local horizontal plane from the Northerly direction to the Easterly direction.

getHorizontal

public final double getHorizontal()

Gets the linear coordinate measured in the local horizontal plane.

getVertical

public final double getVertical()

Gets the linear coordinate measured perpendicular to the local horizontal plane.

getLength

public final int getLength()

Gets the number of elements in this set of coordinates.

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 Azimuth (get), Horizontal (get), and Vertical (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
                                AzimuthHorizontalVertical other)

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

Specified by:

equalsType in interface IEquatable<AzimuthHorizontalVertical>

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
                                   AzimuthHorizontalVertical 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<AzimuthHorizontalVertical>

Parameters:

other - The set of AzimuthHorizontalVertical 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 "Azimuth, Horizontal, Vertical".

equals

public static boolean equals(@Nonnull
                             AzimuthHorizontalVertical left,
                             @Nonnull
                             AzimuthHorizontalVertical 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
                                AzimuthHorizontalVertical left,
                                @Nonnull
                                AzimuthHorizontalVertical 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.