fr.cnes.sirius.patrius.bodies

Interface CelestialBodyOrientation

All Superinterfaces:

Serializable

All Known Subinterfaces:

CelestialBodyIAUOrientation

All Known Implementing Classes:

CelestialBodyTabulatedOrientation, UserIAUPole

public interface CelestialBodyOrientation
extends Serializable

Interface to represent a celestial body orientation.

Since:

4.13

Author:

Thibaut BONIT

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CelestialBodyOrientation.OrientationType Describe the orientation type.

Method Summary

Modifier and Type	Method and Description
default AngularCoordinates	getAngularCoordinates(AbsoluteDate date) Getter for the orientation from the ICRF frame to the rotating frame.
AngularCoordinates	getAngularCoordinates(AbsoluteDate date, CelestialBodyOrientation.OrientationType orientationType) Getter for the orientation.
Vector3D	getPole(AbsoluteDate date) Getter for the body North pole direction with respect to a reference frame.
Vector3D	getPoleDerivative(AbsoluteDate date) Getter for the body North pole direction derivative with respect to a reference frame.
double	getPrimeMeridianAngle(AbsoluteDate date) Getter for the prime meridian angle.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date) Getter for the prime meridian angle derivative.
String	toString() Returns a string representation of the body orientation.

Method Detail

getPole

Vector3D getPole(AbsoluteDate date)
          throws PatriusException

Getter for 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).

Parameters:

date - Current date

Returns:

the body North pole direction with respect to a reference frame

Throws:

PatriusException - if attitude cannot be computed for provided date

getPoleDerivative

Vector3D getPoleDerivative(AbsoluteDate date)
                    throws PatriusException

Getter for 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).

Parameters:

date - Current date

Returns:

the body North pole direction derivative with respect to a reference frame

Throws:

PatriusException - if attitude cannot be computed for provided date

getPrimeMeridianAngle

double getPrimeMeridianAngle(AbsoluteDate date)
                      throws PatriusException

Getter for the prime meridian angle.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true rotating).

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

Parameters:

date - Current date

Returns:

the prime meridian vector

Throws:

PatriusException - if attitude cannot be computed for provided date

getPrimeMeridianAngleDerivative

double getPrimeMeridianAngleDerivative(AbsoluteDate date)
                                throws PatriusException

Getter for the prime meridian angle derivative.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true rotating).

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

Parameters:

date - Current date

Returns:

the prime meridian angle derivative

Throws:

PatriusException - if attitude cannot be computed for provided date

getAngularCoordinates

default AngularCoordinates getAngularCoordinates(AbsoluteDate date)
                                          throws PatriusException

Getter for the orientation from the ICRF frame to the rotating frame.

Parameters:

date - Current date

Returns:

the orientation from the ICRF frame to the rotating frame

Throws:

PatriusException - if attitude cannot be computed for provided date

getAngularCoordinates

AngularCoordinates getAngularCoordinates(AbsoluteDate date,
                                         CelestialBodyOrientation.OrientationType orientationType)
                                  throws PatriusException

Getter for the orientation.

Parameters:

date - Current date

orientationType - Indicates the expected orientation type

Returns:

the orientation

Throws:

PatriusException - if attitude cannot be computed for provided date

toString

String toString()

Returns a string representation of the body orientation.

Overrides:

toString in class Object

Returns:

a string representation of the body orientation