fr.cnes.sirius.patrius.bodies

Class AbstractCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

All Implemented Interfaces:

CelestialBody, CelestialPoint, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

AbstractIAUCelestialBody, UserCelestialBody

public abstract class AbstractCelestialBody
extends AbstractCelestialPoint
implements CelestialBody

Abstract implementation of the CelestialBody interface.

This abstract implementation provides basic services that can be shared by most implementations of the CelestialBody interface. It holds the gravitational attraction coefficient and build the body-centered frames.

Author:

Luc Maisonobe

See Also:

CelestialBodyOrientation, Serialized Form

Nested Class Summary

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

CelestialPoint.BodyNature

Field Summary

Fields

Modifier and Type	Field and Description
static String	INERTIAL_FRAME Inertial, body-centered frame name.
static String	ROTATING_FRAME Body-centered frame name.
static char	SPACE Space.

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

ECLIPTICJ2000_FRAME_NAME, EME2000_FRAME_NAME, ICRF_FRAME_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCelestialBody(String name, double gm, CelestialBodyEphemeris ephemeris, CelestialBodyFrame icrf) Constructor with user-defined ICRF frame.
protected	AbstractCelestialBody(String name, double gm, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame) Constructor without ephemeris.
protected	AbstractCelestialBody(String name, double gm, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, CelestialBodyEphemeris ephemeris) Constructor.
protected	AbstractCelestialBody(String name, GravityModel gravityModel, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, BSPEphemerisLoader.SpiceJ2000ConventionEnum convention, CelestialBodyEphemeris ephemeris) Constructor.

Method Summary

Modifier and Type	Method and Description
double	getGM() Get the central attraction coefficient of the celestial point.
GravityModel	getGravityModel() Getter for the gravitational attraction model of the body.
CelestialBodyFrame	getInertialFrame() Getter for an inertially oriented, body centered frame.
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	setGM(double gmIn) Set a central attraction coefficient to the celestial point.
void	setGravityModel(GravityModel modelIn) Setter for a gravitational attraction model to the body.
void	setOrientation(CelestialBodyOrientation celestialBodyOrientationIn) Setter for a celestial body orientation to define the body frames.
void	setShape(BodyShape shapeIn) Setter for a geometric shape to the body.
String	toString() Returns a string representation of the celestial point and its attributes.

Methods inherited from class fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

getEclipticJ2000, getEME2000, getEphemeris, getICRF, getName, getNativeFrame, getPVCoordinates, setEphemeris

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getBodyNature, getName

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

getEclipticJ2000, getEME2000, getEphemeris, getICRF, setEphemeris

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

getNativeFrame, getPVCoordinates

Field Detail

INERTIAL_FRAME

public static final String INERTIAL_FRAME

Inertial, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME

public static final String ROTATING_FRAME

Body-centered frame name.

See Also:

Constant Field Values

SPACE

public static final char SPACE

Space.

See Also:

Constant Field Values

Constructor Detail

AbstractCelestialBody

protected AbstractCelestialBody(String name,
                                GravityModel gravityModel,
                                CelestialBodyOrientation celestialBodyOrientation,
                                Frame parentFrame,
                                BSPEphemerisLoader.SpiceJ2000ConventionEnum convention,
                                CelestialBodyEphemeris ephemeris)

Constructor.

Parameters:

name - name of the body

gravityModel - gravity model

celestialBodyOrientation - celestial body orientation

parentFrame - parent frame (usually it should be the ICRF centered on the parent body)

convention - spice convention for BSP frames

ephemeris - ephemeris

Throws:

IllegalStateException - if the celestial body orientation is nor a CelestialBodyIAUOrientation or a CelestialBodyTabulatedOrientation implementation

AbstractCelestialBody

protected AbstractCelestialBody(String name,
                                double gm,
                                CelestialBodyOrientation celestialBodyOrientation,
                                Frame parentFrame)

Constructor without ephemeris. Ephemeris can be defined later.

Parameters:

name - name of the body

gm - gravitational attraction coefficient (in m³/s²)

celestialBodyOrientation - celestial body orientation

parentFrame - parent frame (usually it should be the ICRF centered on the parent body)

Throws:

IllegalStateException - if the celestial body orientation is nor a CelestialBodyIAUOrientation or a CelestialBodyTabulatedOrientation implementation

AbstractCelestialBody

protected AbstractCelestialBody(String name,
                                double gm,
                                CelestialBodyOrientation celestialBodyOrientation,
                                Frame parentFrame,
                                CelestialBodyEphemeris ephemeris)

Constructor.

Parameters:

name - name of the body

gm - gravitational attraction coefficient (in m³/s²)

celestialBodyOrientation - celestial body orientation

parentFrame - parent frame (usually it should be the ICRF centered on the parent body)

ephemeris - ephemeris

Throws:

IllegalStateException - if the celestial body orientation is nor a CelestialBodyIAUOrientation or a CelestialBodyTabulatedOrientation implementation

AbstractCelestialBody

protected AbstractCelestialBody(String name,
                                double gm,
                                CelestialBodyEphemeris ephemeris,
                                CelestialBodyFrame icrf)

Constructor with user-defined ICRF frame.

Parameters:

name - name of the body

gm - gravitational attraction coefficient (in m³/s²)

ephemeris - ephemeris

icrf - icrf frame centered on this body

Method Detail

getOrientation

public CelestialBodyOrientation getOrientation()

Getter for the celestial body orientation and primer meridians orientation.

Specified by:

getOrientation in interface CelestialBody

Returns:

the celestial body orientation

setOrientation

public void setOrientation(CelestialBodyOrientation celestialBodyOrientationIn)

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

Specified by:

setOrientation in interface CelestialBody

Parameters:

celestialBodyOrientationIn - the celestial body orientation

getInertialFrame

public CelestialBodyFrame getInertialFrame()
                                    throws PatriusException

Getter for an inertially oriented, body centered frame.

Specified by:

getInertialFrame in interface CelestialBody

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

public CelestialBodyFrame getRotatingFrame()
                                    throws PatriusException

Getter for a body oriented, body centered frame.

Specified by:

getRotatingFrame in interface CelestialBody

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getShape

public BodyShape getShape()

Getter for the geometric shape of the body.

Specified by:

getShape in interface CelestialBody

Returns:

geometric shape of the body

setShape

public final void setShape(BodyShape shapeIn)

Setter for a geometric shape to the body.

Specified by:

setShape in interface CelestialBody

Parameters:

shapeIn - the shape of the body

getGravityModel

public GravityModel getGravityModel()

Getter for the gravitational attraction model of the body.

Specified by:

getGravityModel in interface CelestialBody

Returns:

the gravitational attraction model

setGravityModel

public final void setGravityModel(GravityModel modelIn)

Setter for a gravitational attraction model to the body.

Specified by:

setGravityModel in interface CelestialBody

Parameters:

modelIn - the gravitational attraction model

getGM

public double getGM()

Get the central attraction coefficient of the celestial point.

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

Specified by:

getGM in interface CelestialPoint

Overrides:

getGM in class AbstractCelestialPoint

Returns:

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

setGM

public void setGM(double gmIn)

Set a central attraction coefficient to the celestial point.

Specified by:

setGM in interface CelestialPoint

Overrides:

setGM in class AbstractCelestialPoint

Parameters:

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

toString

public String toString()

Returns a string representation of the celestial point and its attributes.

Specified by:

toString in interface CelestialPoint

Overrides:

toString in class AbstractCelestialPoint

Returns:

a string representation of the celestial point and its attributes