fr.cnes.sirius.patrius.bodies

Interface CelestialBody

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Implementing Classes:

AbstractCelestialBody, 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
AttractionModel	getAttractionModel() Get the attraction model of the body.
Frame	getConstantRotatingFrame() Get a body oriented, body centered frame taking into account only constant part of IAU pole data with respect to inertially-oriented frame.
double	getGM() Get the central attraction coefficient of the body.
IAUPole	getIAUPole() Get the IAU pole and primer meridians orientation.
Frame	getICRF() Get an ICRF, body centered frame.
Frame	getInertialEquatorFrame() Get an inertially oriented, body centered frame taking into account only constant part of IAU pole data with respect to ICRF frame.
Frame	getMeanEquatorFrame() Get an inertially oriented, body centered frame taking into account only constant and secular part of IAU pole data with respect to ICRF frame.
Frame	getMeanRotatingFrame() Get a body oriented, body centered frame taking into account constant and secular part of IAU pole data with respect to mean equator frame.
String	getName() Get the name of the body.
GeometricBodyShape	getShape() Get the geometric shape of the body.
Frame	getTrueEquatorFrame() Get an inertially oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to ICRF frame.
Frame	getTrueRotatingFrame() Get a body oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to true equator frame.
void	setAttractionModel(AttractionModel attractionModelIn) Set an attraction model to the body.
void	setGM(double gmIn) Set a central attraction coefficient to the body.
void	setIAUPole(IAUPole iauPoleIn) Set a IAU Pole to define the body frames.
void	setShape(GeometricBodyShape shapeIn) Set a geometric shape to 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

getNativeFrame, getPVCoordinates

Method Detail

getICRF

Frame getICRF()
       throws PatriusException

Get an ICRF, 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:

getTrueRotatingFrame()

getInertialEquatorFrame

Frame getInertialEquatorFrame()
                       throws PatriusException

Get an inertially oriented, body centered frame taking into account only constant part of IAU pole data with respect to ICRF 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

getMeanEquatorFrame

Frame getMeanEquatorFrame()
                   throws PatriusException

Get an inertially oriented, body centered frame taking into account only constant and secular part of IAU pole data with respect to ICRF frame.

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getTrueEquatorFrame

Frame getTrueEquatorFrame()
                   throws PatriusException

Get an inertially oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to ICRF frame.

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getConstantRotatingFrame

Frame getConstantRotatingFrame()
                        throws PatriusException

Get a body oriented, body centered frame taking into account only constant part of IAU pole data with respect to inertially-oriented 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:

getInertialEquatorFrame()

getMeanRotatingFrame

Frame getMeanRotatingFrame()
                    throws PatriusException

Get a body oriented, body centered frame taking into account constant and secular part of IAU pole data with respect to mean equator 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:

getMeanEquatorFrame()

getTrueRotatingFrame

Frame getTrueRotatingFrame()
                    throws PatriusException

Get a body oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to true equator 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:

getInertialEquatorFrame()

getShape

GeometricBodyShape getShape()

Get the geometric shape of the body.

Returns:

geometric shape of the body

setShape

void setShape(GeometricBodyShape shapeIn)

Set a geometric shape to the body.

Parameters:

shapeIn - the shape of the body

getName

String getName()

Get the name of the body.

Returns:

name of the body

getGM

double getGM()

Get the central attraction coefficient of the body.

Warning: attraction model should not be null (it is not null by default)/

Returns:

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

setGM

void setGM(double gmIn)

Set a central attraction coefficient to the body.

Parameters:

gmIn - the central attraction coefficient (m³/s²)

getIAUPole

IAUPole getIAUPole()

Get the IAU pole and primer meridians orientation.

Returns:

the IAU Pole

setIAUPole

void setIAUPole(IAUPole iauPoleIn)

Set a IAU Pole to define the body frames.

Parameters:

iauPoleIn - the IAU pole

getAttractionModel

AttractionModel getAttractionModel()

Get the attraction model of the body.

Returns:

the attraction model

setAttractionModel

void setAttractionModel(AttractionModel attractionModelIn)

Set an attraction model to the body.

Parameters:

attractionModelIn - the attraction model

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