fr.cnes.sirius.patrius.bodies

Class AbstractCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

All Implemented Interfaces:

CelestialBody, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

MeeusMoon, MeeusMoonStela, MeeusSun, UserCelestialBody

public abstract class AbstractCelestialBody
extends Object
implements CelestialBody

Abstract implementation of the CelestialBody interface.

This abstract implementation provides basic services that can be shared by most implementations of the CelestialBody interface. It holds the attraction coefficient and build the body-centered frames automatically using the definitions of pole and prime meridianspecified by the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements of the Planets and Satellites (WGCCRE).

Author:

Luc Maisonobe

See Also:

IAUPole, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCelestialBody(String nameIn, double gmIn, IAUPole iauPoleIn, Frame definingFrameIn, String inertialFrameName, String bodyFrameName) Build an instance and the underlying frame.

Method Summary

Modifier and Type	Method and Description
Frame	getBodyOrientedFrame() Get a body oriented, body centered frame.
double	getGM() Get the attraction coefficient of the body.
Frame	getInertiallyOrientedFrame() Get an inertially oriented, body centered frame.
String	getName() Get the name of the body.
abstract PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
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

AbstractCelestialBody

protected AbstractCelestialBody(String nameIn,
                                double gmIn,
                                IAUPole iauPoleIn,
                                Frame definingFrameIn,
                                String inertialFrameName,
                                String bodyFrameName)

Build an instance and the underlying frame.

Parameters:

nameIn - name of the body

gmIn - attraction coefficient (in m³/s²)

iauPoleIn - IAU pole implementation

definingFrameIn - frame in which celestial body coordinates are defined

inertialFrameName - name to use for inertially oriented body centered frame

bodyFrameName - name to use for body oriented body centered frame

Method Detail

getName

public String getName()

Get the name of the body.

Specified by:

getName in interface CelestialBody

Returns:

name of the body

getGM

public double getGM()

Get the attraction coefficient of the body.

Specified by:

getGM in interface CelestialBody

Returns:

attraction coefficient of the body (m³/s²)

getInertiallyOrientedFrame

public Frame getInertiallyOrientedFrame()

Get an inertially oriented, body centered frame.

The frame is always bound to the body center, and its axes have a fixed orientation with respect to other inertial frames.

Specified by:

getInertiallyOrientedFrame in interface CelestialBody

Returns:

an inertially oriented, body centered frame

See Also:

CelestialBody.getBodyOrientedFrame()

getBodyOrientedFrame

public Frame getBodyOrientedFrame()

Get a body oriented, body centered frame.

The frame is always bound to the body center, and its axes have a fixed orientation with respect to the celestial body.

Specified by:

getBodyOrientedFrame in interface CelestialBody

Returns:

a body oriented, body centered frame

See Also:

CelestialBody.getInertiallyOrientedFrame()

getPVCoordinates

public abstract PVCoordinates getPVCoordinates(AbsoluteDate date,
                                               Frame frame)
                                        throws PatriusException

Get the PVCoordinates of the body in the selected frame.

Specified by:

getPVCoordinates in interface PVCoordinatesProvider

Parameters:

date - current date

frame - the frame where to define the position

Returns:

position/velocity of the body (m and m/s)

Throws:

PatriusException - if position cannot be computed in given frame

toString

public String toString()

Returns a string representation of the body and its attributes.

Specified by:

toString in interface CelestialBody

Overrides:

toString in class Object

Returns:

a string representation of the body and its attributes