agi.foundation.celestial

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

Class IauOrientationParameters

java.lang.Object

agi.foundation.celestial.IauOrientationParameters

All Implemented Interfaces:

IEquatable<IauOrientationParameters>

public final class IauOrientationParameters
extends Object
implements IEquatable<IauOrientationParameters>

A structure containing the orientation data computed at a particular time. The data represent the direction of the pole of rotation and the rotation about that pole.

These values correspond to what is released by the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements, with two notable exceptions: the values are in radians as opposed to degrees, and the analytical models are computed in terrestrial time as opposed to barycentric dynamical time.

Constructor Summary

Constructors

Constructor and Description
IauOrientationParameters(double rightAscension, double declination, double rotation, double rotationRate) Instantiate a new instance.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(IauOrientationParameters left, IauOrientationParameters 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	equalsType(IauOrientationParameters other) Indicates whether another instance of this type is exactly equal to this instance.
double	getDeclination() Gets the declination of the north pole of the body with respect to the International Celestial Reference Frame, in radians.
double	getRightAscension() Gets the right ascension of the north pole of the body with respect to the International Celestial Reference Frame, in radians.
double	getRotation() Gets the rotation about the north pole used to align a set of axes with the meridian defined by the IAU report, in radians.
double	getRotationRate() Gets the instantaneous rotation rate about the north pole, in radians per second.
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(IauOrientationParameters left, IauOrientationParameters right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

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

Constructor Detail

IauOrientationParameters

public IauOrientationParameters(double rightAscension,
                                double declination,
                                double rotation,
                                double rotationRate)

Instantiate a new instance.

Parameters:

rightAscension - The right ascension of the pole, in radians.

declination - The declination of the pole, in radians.

rotation - The rotation about the pole, in radians.

rotationRate - The rotation rate about the pole, in radians per second.

Method Detail

getRightAscension

public final double getRightAscension()

Gets the right ascension of the north pole of the body with respect to the International Celestial Reference Frame, in radians.

getDeclination

public final double getDeclination()

Gets the declination of the north pole of the body with respect to the International Celestial Reference Frame, in radians.

getRotation

public final double getRotation()

Gets the rotation about the north pole used to align a set of axes with the meridian defined by the IAU report, in radians.

getRotationRate

public final double getRotationRate()

Gets the instantaneous rotation rate about the north pole, in radians per second.

equalsType

public final boolean equalsType(IauOrientationParameters other)

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

Specified by:

equalsType in interface IEquatable<IauOrientationParameters>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; 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

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)

equals

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