org.orekit.bodies

Interface CelestialBody

All Superinterfaces:

PVCoordinatesProvider, Serializable

public interface CelestialBody
extends Serializable, PVCoordinatesProvider

Interface for celestial bodies like Sun, Moon or solar system planets.

Author:

Luc Maisonobe

See Also:

CelestialBodyFactory

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.
<T extends org.hipparchus.RealFieldElement<T>> TimeStampedFieldPVCoordinates<T>	getPVCoordinates(FieldAbsoluteDate<T> date, Frame frame) Get the TimeStampedFieldPVCoordinates of the body in the selected frame.

Methods inherited from interface org.orekit.utils.PVCoordinatesProvider

getPVCoordinates

Method Detail

getInertiallyOrientedFrame

Frame getInertiallyOrientedFrame()
                          throws OrekitException

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.

Returns:

an inertially oriented, body centered frame

Throws:

OrekitException - if frame cannot be retrieved

See Also:

getBodyOrientedFrame()

getBodyOrientedFrame

Frame getBodyOrientedFrame()
                    throws OrekitException

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.

Returns:

a body oriented, body centered frame

Throws:

OrekitException - if frame cannot be retrieved

See Also:

getInertiallyOrientedFrame()

getName

String getName()

Get the name of the body.

Returns:

name of the body

getGM

double getGM()

Get the attraction coefficient of the body.

Returns:

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

getPVCoordinates

<T extends org.hipparchus.RealFieldElement<T>> TimeStampedFieldPVCoordinates<T> getPVCoordinates(FieldAbsoluteDate<T> date,
                                                                                                 Frame frame)
                                                                                          throws OrekitException

Get the TimeStampedFieldPVCoordinates of the body in the selected frame.

Type Parameters:

T - type fo the field elements

Parameters:

date - current date

frame - the frame where to define the position

Returns:

time-stamped position/velocity of the body (m and m/s)

Throws:

OrekitException - if position cannot be computed in given frame

See Also:

PVCoordinatesProvider.getPVCoordinates(org.orekit.time.AbsoluteDate, Frame)