fr.cnes.sirius.patrius.bodies

Interface CelestialBody

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Implementing Classes:

AbstractCelestialBody, MeeusMoon, MeeusMoonStela, MeeusSun, UserCelestialBody

public interface CelestialBody
extends 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
CelestialBodyFrame	getEME2000() Get an EME2000, body centered frame.
CelestialBodyEphemeris	getEphemeris() Get the ephemeris of the body.
double	getGM() Get the central attraction coefficient of the body.
GravityModel	getGravityModel() Get the gravitational attraction model of the body.
IAUPole	getIAUPole() Get the IAU pole and primer meridians orientation.
CelestialBodyFrame	getICRF() Get an ICRF, body centered frame.
CelestialBodyFrame	getInertialFrame(IAUPoleModelType iauPole) Get an inertially oriented, body centered frame.
String	getName() Get the name of the body.
CelestialBodyFrame	getRotatingFrame(IAUPoleModelType iauPole) Get a body oriented, body centered frame.
BodyShape	getShape() Get the geometric shape of the body.
void	setEphemeris(CelestialBodyEphemeris ephemerisIn) Set an ephemeris to the body.
void	setGM(double gmIn) Set a central attraction coefficient to the body.
void	setGravityModel(GravityModel gravityModelIn) Set a gravitational attraction model to the body.
void	setIAUPole(IAUPole iauPoleIn) Set a IAU Pole to define the body frames.
void	setShape(BodyShape 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

CelestialBodyFrame 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:

#getRotatingFrame(IAUPoleModelType.TRUE)

getEME2000

CelestialBodyFrame getEME2000()
                       throws PatriusException

Get an EME2000, body centered frame.

The frame is always bound to the body center, and its axes are colinear to Earth EME2000 frame.

Returns:

an EME2000, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getInertialFrame

CelestialBodyFrame getInertialFrame(IAUPoleModelType iauPole)
                             throws PatriusException

Get an inertially oriented, body centered frame.

Warning: Inertiality of such frame depends on its definition and on its use: if related IAUPole includes strong precession/nutation effect and temporal horizon of use is long, frame may not be considered inertial. As a rule of thumb, precession/nutation effects of Earth frames such as CIRF/MOD are considered small enough on a horizon of a day to consider them pseudo-inertial. Also frames based on IAUPoleModelType.CONSTANT will be more inertial than IAUPoleModelType.MEAN and than IAUPoleModelType.TRUE. Similarly, models including IAUPoleFunction.IAUTimeDependency.DAYS with high values will tend to be less inertial than models including IAUPoleFunction.IAUTimeDependency.CENTURIES with high values. Definition of sufficiently inertial precession/nutation effects remains on the user responsibility depending on the frame usage.

Parameters:

iauPole - the type of IAUPole used for the frame

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

CelestialBodyFrame getRotatingFrame(IAUPoleModelType iauPole)
                             throws PatriusException

Get a body oriented, body centered frame.

Parameters:

iauPole - the type of IAUPole used for the frame

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getShape

BodyShape getShape()

Get the geometric shape of the body.

Returns:

geometric shape of the body

setShape

void setShape(BodyShape 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

getGravityModel

GravityModel getGravityModel()

Get the gravitational attraction model of the body.

Returns:

the gravitational attraction model

setGravityModel

void setGravityModel(GravityModel gravityModelIn)

Set a gravitational attraction model to the body.

Parameters:

gravityModelIn - the gravitational attraction model

getEphemeris

CelestialBodyEphemeris getEphemeris()

Get the ephemeris of the body.

Returns:

the ephemeris

setEphemeris

void setEphemeris(CelestialBodyEphemeris ephemerisIn)

Set an ephemeris to the body.

Parameters:

ephemerisIn - the ephemeris

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