agi.foundation.celestial

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

Class EarthOrientationParametersData

java.lang.Object

agi.foundation.celestial.EarthOrientationParametersData

All Implemented Interfaces:

IEquatable<EarthOrientationParametersData>

public class EarthOrientationParametersData
extends Object
implements IEquatable<EarthOrientationParametersData>

Specifies Earth Orientation Parameters at a specific instant.

Constructor Summary

Constructors

Constructor and Description
EarthOrientationParametersData(JulianDate date, double poleWanderX, double poleWanderY, double ut1MinusUtc) Initializes a new instance with the specified parameters.
EarthOrientationParametersData(JulianDate date, double poleWanderX, double poleWanderY, double ut1MinusUtc, double lengthOfDay, double dPsi, double dEpsilon, double celestialPoleOffsetX, double celestialPoleOffsetY, double taiOffsetToUtc) Initializes a new instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(EarthOrientationParametersData left, EarthOrientationParametersData 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(EarthOrientationParametersData other) Indicates whether another instance of this type is exactly equal to this instance.
double	getCelestialPoleOffsetX() Gets the x-offset to the definition of the Celestial Intermediate Pole (CIP), in arc seconds.
double	getCelestialPoleOffsetY() Gets the y-offset to the definition of the Celestial Intermediate Pole (CIP), in arc seconds.
JulianDate	getDate() Gets the instant at which the parameters are specified, in the TAI time standard.
double	getDeltaEpsilonCorrection() Gets the correction to the nutation in the obliquity of the ecliptic (delta Delta epsilon) with respect to the IAU1980 theory, in arc seconds.
double	getDeltaPsiCorrection() Gets the correction to the nutation in longitude (delta Delta psi) with respect to the IAU1980 theory, in arc seconds.
double	getLengthOfDayCorrection() Gets the correction to the length of a solar day ("LOD"), in seconds.
double	getPoleWanderX() Gets the pole wander in the X direction at this instant, in arc seconds.
double	getPoleWanderY() Gets the pole wander in the Y direction at this instant, in arc seconds.
double	getSecondsDifference() Gets the number of seconds difference between Date (get) in UTC and TAI.
double	getTaiOffsetFromUtc() Gets the number of leap seconds ("DAT") as specified in the EOP file.
double	getUt1MinusUtc() Gets the difference UT1 - UTC at this instant.
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(EarthOrientationParametersData left, EarthOrientationParametersData 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

EarthOrientationParametersData

public EarthOrientationParametersData(@Nonnull
                                      JulianDate date,
                                      double poleWanderX,
                                      double poleWanderY,
                                      double ut1MinusUtc)

Initializes a new instance with the specified parameters.

Parameters:

date - The instant at which the parameters are specified, in UTC.

poleWanderX - The pole wander in the X direction at this instance, in arc seconds.

poleWanderY - The pole wander in the Y direction at this instance, in arc seconds.

ut1MinusUtc - The difference UT1 - UTC at this instant.

EarthOrientationParametersData

public EarthOrientationParametersData(@Nonnull
                                      JulianDate date,
                                      double poleWanderX,
                                      double poleWanderY,
                                      double ut1MinusUtc,
                                      double lengthOfDay,
                                      double dPsi,
                                      double dEpsilon,
                                      double celestialPoleOffsetX,
                                      double celestialPoleOffsetY,
                                      double taiOffsetToUtc)

Initializes a new instance with the specified parameters.

Parameters:

date - The instant at which the parameters are specified, in UTC.

poleWanderX - The pole wander in the X direction at this instance, in arc seconds.

poleWanderY - The pole wander in the Y direction at this instance, in arc seconds.

ut1MinusUtc - The difference UT1 - UTC at this instant.

lengthOfDay - The correction to the length of a standard solar day (86400.0 Seconds).

dPsi - The correction to nutation in longitude from the IAU1980 theory, in arc seconds.

dEpsilon - The correction to nutation in obliquity from the IAU1980 theory, in arc seconds.

celestialPoleOffsetX - The x-offset to the celestial intermediate pole (CIP), in arc seconds.

celestialPoleOffsetY - The y-offset to the celestial intermediate pole (CIP), in arc seconds.

taiOffsetToUtc - The number of leap seconds for the given date.

Method Detail

getDate

@Nonnull
public final JulianDate getDate()

Gets the instant at which the parameters are specified, in the TAI time standard.

getSecondsDifference

public final double getSecondsDifference()

Gets the number of seconds difference between Date (get) in UTC and TAI.

getPoleWanderX

public final double getPoleWanderX()

Gets the pole wander in the X direction at this instant, in arc seconds.

getPoleWanderY

public final double getPoleWanderY()

Gets the pole wander in the Y direction at this instant, in arc seconds.

getUt1MinusUtc

public final double getUt1MinusUtc()

Gets the difference UT1 - UTC at this instant.

getLengthOfDayCorrection

public final double getLengthOfDayCorrection()

Gets the correction to the length of a solar day ("LOD"), in seconds. This defines the difference between the astronomically determined length of a day and the length of a standard solar day (86400.0 SI Seconds). This accounts for effects from zonal tides, oceanic tides, angular momentum transfer from the moon, and other effects on the Earth's rotation.

For predicted data, or when no data is available, the length of day is set to zero.

getDeltaPsiCorrection

public final double getDeltaPsiCorrection()

Gets the correction to the nutation in longitude (delta Delta psi) with respect to the IAU1980 theory, in arc seconds.

getDeltaEpsilonCorrection

public final double getDeltaEpsilonCorrection()

Gets the correction to the nutation in the obliquity of the ecliptic (delta Delta epsilon) with respect to the IAU1980 theory, in arc seconds.

getTaiOffsetFromUtc

public final double getTaiOffsetFromUtc()

Gets the number of leap seconds ("DAT") as specified in the EOP file. This yields the relationship between the UTC and TAI time scales by the following relation: DAT = TAI - UTC

getCelestialPoleOffsetX

public final double getCelestialPoleOffsetX()

Gets the x-offset to the definition of the Celestial Intermediate Pole (CIP), in arc seconds.

This primarily accounts for the non-fixed liquid core of the Earth which represents an unpredictable effect on the position of the Earth.

getCelestialPoleOffsetY

public final double getCelestialPoleOffsetY()

Gets the y-offset to the definition of the Celestial Intermediate Pole (CIP), in arc seconds.

This primarily accounts for the non-fixed liquid core of the Earth which represents an unpredictable effect on the position of the Earth.

equalsType

public final boolean equalsType(EarthOrientationParametersData other)

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

Specified by:

equalsType in interface IEquatable<EarthOrientationParametersData>

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(EarthOrientationParametersData left,
                             EarthOrientationParametersData 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(EarthOrientationParametersData left,
                                EarthOrientationParametersData 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.