fr.cnes.sirius.patrius.bodies

Interface CelestialBody

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Implementing Classes:

AbstractCelestialBody, FacetCelestialBody, MeeusMoon, MeeusMoonStela, MeeusSun, UserCelestialBody

public interface CelestialBody
extends Serializable, PVCoordinatesProvider

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

Author:

Luc Maisonobe

See Also:

CelestialBodyFactory, IAUPole

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.
String	toString() Returns a string representation of the body and its attributes.

Methods inherited from interface fr.cnes.sirius.patrius.orbits.pvcoordinates.PVCoordinatesProvider

getPVCoordinates

Method Detail

getInertiallyOrientedFrame

Frame getInertiallyOrientedFrame()
                          throws PatriusException

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:

PatriusException - if frame cannot be retrieved

See Also:

getBodyOrientedFrame()

getBodyOrientedFrame

Frame getBodyOrientedFrame()
                    throws PatriusException

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:

PatriusException - 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²)

toString

String toString()

Returns a string representation of the body and its attributes.

Overrides:

toString in class Object

Returns:

a string representation of the body and its attributes