fr.cnes.sirius.patrius.bodies

Interface CelestialBody

All Superinterfaces:

CelestialPoint, PVCoordinatesProvider, Serializable

All Known Subinterfaces:

IAUCelestialBody

All Known Implementing Classes:

AbstractCelestialBody, AbstractIAUCelestialBody, Earth, MeeusMoon, MeeusMoonStela, MeeusSun, UserCelestialBody, UserIAUCelestialBody

public interface CelestialBody
extends CelestialPoint

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

Celestial Barycenters are handled by class BasicCelestialPoint.

Since:

4.13

Author:

Emmanuel Bignon

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.bodies.CelestialPoint

CelestialPoint.BodyNature

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.bodies.CelestialPoint

ECLIPTICJ2000_FRAME_NAME, EME2000_FRAME_NAME, ICRF_FRAME_NAME

Method Summary

Modifier and Type	Method and Description
default CelestialPoint.BodyNature	getBodyNature() Getter for the celestial body nature.
GravityModel	getGravityModel() Getter for the gravitational attraction model of the body.
CelestialBodyFrame	getInertialFrame() Getter for an inertially oriented, body centered frame.
String	getName() Getter for the name of the body.
CelestialBodyOrientation	getOrientation() Getter for the celestial body orientation and primer meridians orientation.
CelestialBodyFrame	getRotatingFrame() Getter for a body oriented, body centered frame.
BodyShape	getShape() Getter for the geometric shape of the body.
void	setGravityModel(GravityModel gravityModelIn) Setter for a gravitational attraction model to the body.
void	setOrientation(CelestialBodyOrientation celestialBodyOrientation) Setter for a celestial body orientation to define the body frames.
void	setShape(BodyShape shapeIn) Setter for a geometric shape to the body.

Methods inherited from interface fr.cnes.sirius.patrius.bodies.CelestialPoint

getEclipticJ2000, getEME2000, getEphemeris, getGM, getICRF, setEphemeris, setGM, toString

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

getNativeFrame, getPVCoordinates

Method Detail

getInertialFrame

CelestialBodyFrame getInertialFrame()
                             throws PatriusException

Getter for an inertially oriented, body centered frame.

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

CelestialBodyFrame getRotatingFrame()
                             throws PatriusException

Getter for a body oriented, body centered frame.

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getShape

BodyShape getShape()

Getter for the geometric shape of the body.

Returns:

geometric shape of the body

setShape

void setShape(BodyShape shapeIn)

Setter for a geometric shape to the body.

Parameters:

shapeIn - the shape of the body

getName

String getName()

Getter for the name of the body.

Specified by:

getName in interface CelestialPoint

Returns:

name of the body

getOrientation

CelestialBodyOrientation getOrientation()

Getter for the celestial body orientation and primer meridians orientation.

Returns:

the celestial body orientation

setOrientation

void setOrientation(CelestialBodyOrientation celestialBodyOrientation)

Setter for a celestial body orientation to define the body frames.

Parameters:

celestialBodyOrientation - the celestial body orientation

getGravityModel

GravityModel getGravityModel()

Getter for the gravitational attraction model of the body.

Returns:

the gravitational attraction model

setGravityModel

void setGravityModel(GravityModel gravityModelIn)

Setter for a gravitational attraction model to the body.

Parameters:

gravityModelIn - the gravitational attraction model

getBodyNature

default CelestialPoint.BodyNature getBodyNature()

Getter for the celestial body nature.

Specified by:

getBodyNature in interface CelestialPoint

Returns:

the celestial body nature