agi.foundation

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

Class DegreesMinutesSeconds

java.lang.Object

agi.foundation.DegreesMinutesSeconds

All Implemented Interfaces:

IEquatable<DegreesMinutesSeconds>, ImmutableValueType, ValueType, IEquatableEpsilon<DegreesMinutesSeconds>, Comparable<DegreesMinutesSeconds>

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

Holds information about an angle represented in the Degrees Minutes Seconds format.

Note that Minutes (get) and Seconds (get) refer to the arc seconds and arc minutes of this angle, NOT seconds and minutes of time.

Constructor Summary

Constructors

Constructor and Description
DegreesMinutesSeconds() Initializes a new instance.
DegreesMinutesSeconds(int revolutions, int degrees, int minutes, double seconds) Create an instance of a DegreesMinutesSeconds angle with parameters

Method Summary

Modifier and Type	Method and Description
DegreesMinutesSeconds	add(DegreesMinutesSeconds addend) Adds the specified DegreesMinutesSeconds to this instance.
static DegreesMinutesSeconds	add(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Adds two specified DegreesMinutesSeconds instances.
int	compareTo(DegreesMinutesSeconds other) Compares this instance with another instance of the same type.
static boolean	equals(DegreesMinutesSeconds left, DegreesMinutesSeconds 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(DegreesMinutesSeconds other, double epsilon) Indicates whether each DegreesMinutesSeconds value of another instance of this type is within the required tolerance of the corresponding DegreesMinutesSeconds value of this instance.
boolean	equalsType(DegreesMinutesSeconds other) Indicates whether another instance of this type is exactly equal to this instance.
int	getDegrees() Gets the number of degrees.
int	getMinutes() Gets the number of arc minutes.
int	getRevolutions() Gets the number of full 360 degree (2 Pi radians) revolutions.
double	getSeconds() Gets the number of arc seconds.
static boolean	greaterThan(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Returns true if left is greater than right.
static boolean	greaterThanOrEqual(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Returns true if left is greater than or equal to right.
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	lessThan(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Returns true if left is less than right.
static boolean	lessThanOrEqual(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Returns true if left is less than or equal to right.
static DegreesMinutesSeconds	multiply(DegreesMinutesSeconds left, double right) Multiplies the DegreesMinutesSeconds by a constant.
DegreesMinutesSeconds	multiply(double scalar) Multiplies this instance by the scalar provided.
static boolean	notEquals(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Returns true if the two instances are not exactly equal.
DegreesMinutesSeconds	subtract(DegreesMinutesSeconds minuend) Subtracts the specified DegreesMinutesSeconds from this instance.
static DegreesMinutesSeconds	subtract(DegreesMinutesSeconds left, DegreesMinutesSeconds right) Subtracts a specified DegreesMinutesSeconds from another specified DegreesMinutesSeconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

DegreesMinutesSeconds

public DegreesMinutesSeconds()

Initializes a new instance.

DegreesMinutesSeconds

public DegreesMinutesSeconds(int revolutions,
                             int degrees,
                             int minutes,
                             double seconds)

Create an instance of a DegreesMinutesSeconds angle with parameters

Note that the parameters must be of the same sign. That is, if the degrees is negative, then all non-zero parameters must be negative.

Parameters:

revolutions - The number of full 360 degree revolutions.

degrees - The number of degrees.

minutes - The number of arc minutes.

seconds - The number of arc seconds

Method Detail

getRevolutions

public final int getRevolutions()

Gets the number of full 360 degree (2 Pi radians) revolutions.

getDegrees

public final int getDegrees()

Gets the number of degrees.

getMinutes

public final int getMinutes()

Gets the number of arc minutes.

getSeconds

public final double getSeconds()

Gets the number of arc seconds.

add

@Nonnull
public final DegreesMinutesSeconds add(@Nonnull
                                                 DegreesMinutesSeconds addend)

Adds the specified DegreesMinutesSeconds to this instance.

Parameters:

addend - The DegreesMinutesSeconds to add to this instance.

Returns:

A DegreesMinutesSeconds that represents the value of this instance plus the value of addend.

subtract

@Nonnull
public final DegreesMinutesSeconds subtract(@Nonnull
                                                      DegreesMinutesSeconds minuend)

Subtracts the specified DegreesMinutesSeconds from this instance.

Parameters:

minuend - The DegreesMinutesSeconds to subtract from this instance.

Returns:

A DegreesMinutesSeconds that represents the value of this instance minus the value of minuend.

multiply

@Nonnull
public final DegreesMinutesSeconds multiply(double scalar)

Multiplies this instance by the scalar provided.

Parameters:

scalar - The scalar to multiply this angle by.

Returns:

A DegreesMinutesSeconds that represents the value of this instance times the value of scalar.

add

@Nonnull
public static DegreesMinutesSeconds add(@Nonnull
                                                  DegreesMinutesSeconds left,
                                                  @Nonnull
                                                  DegreesMinutesSeconds right)

Adds two specified DegreesMinutesSeconds instances.

Parameters:

left - The first DegreesMinutesSeconds to add.

right - The second DegreesMinutesSeconds to add.

Returns:

The sum of left and right.

subtract

@Nonnull
public static DegreesMinutesSeconds subtract(@Nonnull
                                                       DegreesMinutesSeconds left,
                                                       @Nonnull
                                                       DegreesMinutesSeconds right)

Subtracts a specified DegreesMinutesSeconds from another specified DegreesMinutesSeconds.

Parameters:

left - The subtrahend.

right - The minuend.

Returns:

The difference left minus right.

multiply

@Nonnull
public static DegreesMinutesSeconds multiply(@Nonnull
                                                       DegreesMinutesSeconds left,
                                                       double right)

Multiplies the DegreesMinutesSeconds by a constant.

Parameters:

left - The DegreesMinutesSeconds to multiply.

right - The constant by which to multiply the DegreesMinutesSeconds.

Returns:

A DegreesMinutesSeconds that represents the value of this instance multiplied by the constant.

equals

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

lessThan

public static boolean lessThan(@Nonnull
                               DegreesMinutesSeconds left,
                               @Nonnull
                               DegreesMinutesSeconds right)

Returns true if left is less than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than right; otherwise false.

greaterThan

public static boolean greaterThan(@Nonnull
                                  DegreesMinutesSeconds left,
                                  @Nonnull
                                  DegreesMinutesSeconds right)

Returns true if left is greater than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than right; otherwise false.

lessThanOrEqual

public static boolean lessThanOrEqual(@Nonnull
                                      DegreesMinutesSeconds left,
                                      @Nonnull
                                      DegreesMinutesSeconds right)

Returns true if left is less than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than or equal to right; otherwise false.

greaterThanOrEqual

public static boolean greaterThanOrEqual(@Nonnull
                                         DegreesMinutesSeconds left,
                                         @Nonnull
                                         DegreesMinutesSeconds right)

Returns true if left is greater than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than or equal to right; otherwise false.

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
                                DegreesMinutesSeconds other)

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

Specified by:

equalsType in interface IEquatable<DegreesMinutesSeconds>

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
                                   DegreesMinutesSeconds other,
                                   double epsilon)

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

Specified by:

equalsEpsilon in interface IEquatableEpsilon<DegreesMinutesSeconds>

Parameters:

other - The set of DegreesMinutesSeconds values to compare to this instance.

epsilon - The limit at which the absolute differences between the DegreesMinutesSeconds 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)

compareTo

public final int compareTo(@Nonnull
                           DegreesMinutesSeconds other)

Compares this instance with another instance of the same type.

Specified by:

compareTo in interface Comparable<DegreesMinutesSeconds>

Parameters:

other - An object to compare with this instance.

Returns:

A value indicating the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance is less than other.
Zero	This instance is equal to other.
Greater than zero	This instance is greater than other.