fr.cnes.sirius.patrius.bodies

Class UserIAUPole

java.lang.Object

fr.cnes.sirius.patrius.bodies.UserIAUPole

All Implemented Interfaces:

IAUPole, Serializable

public class UserIAUPole
extends Object
implements IAUPole

Generic IAU pole model for pole and prime meridian orientations.

This class represents the model compliant with the report of the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements of the Planets and Satellites (WGCCRE). These definitions are common for all recent versions of this report published every three years.

The precise values of pole direction and W angle coefficients may vary from publication year as models are adjusted. The latest value of constants for implementing this interface can be found in the working group site.

Since:

4.7

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserIAUPole(IAUPoleCoefficients coefficients) Constructor.

Method Summary

Modifier and Type	Method and Description
Vector3D	getPole(AbsoluteDate date) Get the body North pole direction with respect to a reference frame.
Vector3D	getPole(AbsoluteDate date, GlobalIAUPoleType iauPoleType) Get the body North pole direction with respect to a reference frame.
Vector3D	getPoleDerivative(AbsoluteDate date) Get the body North pole direction derivative with respect to a reference frame.
Vector3D	getPoleDerivative(AbsoluteDate date, GlobalIAUPoleType iauPoleType) Get the body North pole direction derivative with respect to a reference frame.
double	getPrimeMeridianAngle(AbsoluteDate date) Get the prime meridian angle.
double	getPrimeMeridianAngle(AbsoluteDate date, GlobalIAUPoleType iauPoleType) Get the prime meridian angle.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date) Get the prime meridian angle derivative.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date, GlobalIAUPoleType iauPoleType) Get the prime meridian angle derivative.
String	toString() Returns a string representation of the body and its attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserIAUPole

public UserIAUPole(IAUPoleCoefficients coefficients)

Constructor.

Parameters:

coefficients - model coefficients

Method Detail

getPole

public Vector3D getPole(AbsoluteDate date)

Get the body North pole direction with respect to a reference frame. It takes into account constant, secular and harmonics terms (conversion from ICRF to true equator).

Specified by:

getPole in interface IAUPole

Parameters:

date - current date

Returns:

body North pole direction with respect to a reference frame

getPole

public Vector3D getPole(AbsoluteDate date,
                        GlobalIAUPoleType iauPoleType)

Get the body North pole direction with respect to a reference frame.

Specified by:

getPole in interface IAUPole

Parameters:

date - current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean equator/true equator transformation

Returns:

body North pole direction with respect to a reference frame

getPrimeMeridianAngle

public double getPrimeMeridianAngle(AbsoluteDate date)

Get the prime meridian angle.

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

It takes into account constant, secular and harmonics terms (conversion from ICRF to true rotating).

Specified by:

getPrimeMeridianAngle in interface IAUPole

Parameters:

date - current date

Returns:

prime meridian vector

getPrimeMeridianAngle

public double getPrimeMeridianAngle(AbsoluteDate date,
                                    GlobalIAUPoleType iauPoleType)

Get the prime meridian angle.

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

Specified by:

getPrimeMeridianAngle in interface IAUPole

Parameters:

date - current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean rotating/true rotating transformation

Returns:

prime meridian vector

getPoleDerivative

public Vector3D getPoleDerivative(AbsoluteDate date)

Get the body North pole direction derivative with respect to a reference frame. It takes into account constant, secular and harmonics terms (conversion from ICRF to true equator).

Specified by:

getPoleDerivative in interface IAUPole

Parameters:

date - current date

Returns:

body North pole direction derivative with respect to a reference frame

getPoleDerivative

public Vector3D getPoleDerivative(AbsoluteDate date,
                                  GlobalIAUPoleType iauPoleType)

Get the body North pole direction derivative with respect to a reference frame. It takes into account constant, secular and harmonics terms (conversion from ICRF to true equator).

Specified by:

getPoleDerivative in interface IAUPole

Parameters:

date - current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean equator/true equator transformation

Returns:

body North pole direction derivative with respect to a reference frame

getPrimeMeridianAngleDerivative

public double getPrimeMeridianAngleDerivative(AbsoluteDate date)

Get the prime meridian angle derivative.

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

It takes into account constant, secular and harmonics terms (conversion from ICRF to true rotating).

Specified by:

getPrimeMeridianAngleDerivative in interface IAUPole

Parameters:

date - current date

Returns:

prime meridian angle derivative

getPrimeMeridianAngleDerivative

public double getPrimeMeridianAngleDerivative(AbsoluteDate date,
                                              GlobalIAUPoleType iauPoleType)

Get the prime meridian angle derivative.

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

Specified by:

getPrimeMeridianAngleDerivative in interface IAUPole

Parameters:

date - current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean rotating/true rotating transformation

Returns:

prime meridian angle derivative

toString

public String toString()

Returns a string representation of the body and its attributes.

Specified by:

toString in interface IAUPole

Overrides:

toString in class Object

Returns:

a string representation of the body and its attributes