fr.cnes.sirius.patrius.bodies

Class AbstractIAUCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

fr.cnes.sirius.patrius.bodies.AbstractIAUCelestialBody

All Implemented Interfaces:

CelestialBody, CelestialPoint, IAUCelestialBody, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

MeeusMoon, MeeusMoonStela, MeeusSun, UserIAUCelestialBody

public abstract class AbstractIAUCelestialBody
extends AbstractCelestialBody
implements IAUCelestialBody

Abstract implementation of the IAUCelestialBody interface.

This abstract implementation provides basic services that can be shared by most implementations of the IAUCelestialBody interface. It holds the gravitational attraction coefficient and build the body-centered frames automatically using the definitions of pole and prime meridian specified by the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements of the Planets and Satellites (WGCCRE).

Since:

4.14

See Also:

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	CONSTANT Constant model string.
static String	INERTIAL_FRAME_CONSTANT_MODEL Constant (equator) inertial, body-centered frame name.
static String	INERTIAL_FRAME_MEAN_MODEL Mean (equator) inertial, body-centered frame name.
static String	INERTIAL_FRAME_TRUE_MODEL True (equator) inertial, body-centered frame name.
static String	MEAN Mean model string.
static String	ROTATING_FRAME_CONSTANT_MODEL Constant rotating, body-centered frame name.
static String	ROTATING_FRAME_MEAN_MODEL Mean rotating, body-centered frame name.
static String	ROTATING_FRAME_TRUE_MODEL True rotating, body-centered frame name.
static String	TRUE True model string.

Fields inherited from class fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

INERTIAL_FRAME, ROTATING_FRAME, 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	AbstractIAUCelestialBody(String name, double gm, CelestialBodyIAUOrientation celestialBodyIAUOrientation, Frame parentFrame) Constructor without ephemeris.
protected	AbstractIAUCelestialBody(String name, double gm, CelestialBodyIAUOrientation celestialBodyIAUOrientation, Frame parentFrame, CelestialBodyEphemeris ephemeris) Constructor.
protected	AbstractIAUCelestialBody(String name, GravityModel gravityModel, CelestialBodyIAUOrientation celestialBodyIAUOrientation, Frame parentFrame, BSPEphemerisLoader.SpiceJ2000ConventionEnum convention, CelestialBodyEphemeris ephemeris) Constructor.

Method Summary

Modifier and Type	Method and Description
CelestialBodyFrame	getInertialFrame() Getter for an inertially oriented, body centered frame.
CelestialBodyFrame	getInertialFrame(IAUPoleModelType iauPoleIn) Getter for an inertially oriented, body centered frame.
CelestialBodyIAUOrientation	getOrientation() Getter for the celestial body orientation and primer meridians orientation.
CelestialBodyFrame	getRotatingFrame() Getter for a body oriented, body centered frame.
CelestialBodyFrame	getRotatingFrame(IAUPoleModelType iauPoleIn) Getter for a body oriented, body centered frame.
void	setOrientation(CelestialBodyOrientation celestialBodyIAUOrientation) Set a celestial body IAU orientation to define the body frames.
String	toString() Returns a string representation of the celestial point and its attributes.

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

getGM, getGravityModel, getShape, setGM, setGravityModel, setShape

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, getGravityModel, getName, getShape, setGravityModel, setShape

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

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

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

getNativeFrame, getPVCoordinates

Field Detail

CONSTANT

public static final String CONSTANT

Constant model string.

See Also:

Constant Field Values

MEAN

public static final String MEAN

Mean model string.

See Also:

Constant Field Values

TRUE

public static final String TRUE

True model string.

See Also:

Constant Field Values

INERTIAL_FRAME_CONSTANT_MODEL

public static final String INERTIAL_FRAME_CONSTANT_MODEL

Constant (equator) inertial, body-centered frame name.

See Also:

Constant Field Values

INERTIAL_FRAME_MEAN_MODEL

public static final String INERTIAL_FRAME_MEAN_MODEL

Mean (equator) inertial, body-centered frame name.

See Also:

Constant Field Values

INERTIAL_FRAME_TRUE_MODEL

public static final String INERTIAL_FRAME_TRUE_MODEL

True (equator) inertial, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME_CONSTANT_MODEL

public static final String ROTATING_FRAME_CONSTANT_MODEL

Constant rotating, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME_MEAN_MODEL

public static final String ROTATING_FRAME_MEAN_MODEL

Mean rotating, body-centered frame name.

See Also:

Constant Field Values

ROTATING_FRAME_TRUE_MODEL

public static final String ROTATING_FRAME_TRUE_MODEL

True rotating, body-centered frame name.

See Also:

Constant Field Values

Constructor Detail

AbstractIAUCelestialBody

protected AbstractIAUCelestialBody(String name,
                                   GravityModel gravityModel,
                                   CelestialBodyIAUOrientation celestialBodyIAUOrientation,
                                   Frame parentFrame,
                                   BSPEphemerisLoader.SpiceJ2000ConventionEnum convention,
                                   CelestialBodyEphemeris ephemeris)

Constructor.

Parameters:

name - name of the body

gravityModel - gravity model

celestialBodyIAUOrientation - celestial body IAU 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

AbstractIAUCelestialBody

protected AbstractIAUCelestialBody(String name,
                                   double gm,
                                   CelestialBodyIAUOrientation celestialBodyIAUOrientation,
                                   Frame parentFrame)

Constructor without ephemeris. Ephemeris can be defined later.

Parameters:

name - name of the body

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

celestialBodyIAUOrientation - 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

AbstractIAUCelestialBody

protected AbstractIAUCelestialBody(String name,
                                   double gm,
                                   CelestialBodyIAUOrientation celestialBodyIAUOrientation,
                                   Frame parentFrame,
                                   CelestialBodyEphemeris ephemeris)

Constructor.

Parameters:

name - name of the body

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

celestialBodyIAUOrientation - 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

Method Detail

getInertialFrame

public CelestialBodyFrame getInertialFrame(IAUPoleModelType iauPoleIn)
                                    throws PatriusException

Getter for an inertially oriented, body centered frame.

Warning: Inertiality of such frame depends on its definition and on its use: if related CelestialBodyOrientation 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.

Specified by:

getInertialFrame in interface IAUCelestialBody

Parameters:

iauPoleIn - the type of IAUPole used for the frame

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getInertialFrame

public CelestialBodyFrame getInertialFrame()
                                    throws PatriusException

Getter for an inertially oriented, body centered frame.

Specified by:

getInertialFrame in interface CelestialBody

Specified by:

getInertialFrame in interface IAUCelestialBody

Overrides:

getInertialFrame in class AbstractCelestialBody

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

public CelestialBodyFrame getRotatingFrame(IAUPoleModelType iauPoleIn)
                                    throws PatriusException

Getter for a body oriented, body centered frame.

Specified by:

getRotatingFrame in interface IAUCelestialBody

Parameters:

iauPoleIn - the type of IAUPole used for the frame

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

public final CelestialBodyFrame getRotatingFrame()
                                          throws PatriusException

Getter for a body oriented, body centered frame.

Specified by:

getRotatingFrame in interface CelestialBody

Specified by:

getRotatingFrame in interface IAUCelestialBody

Overrides:

getRotatingFrame in class AbstractCelestialBody

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getOrientation

public CelestialBodyIAUOrientation getOrientation()

Getter for the celestial body orientation and primer meridians orientation.

Specified by:

getOrientation in interface CelestialBody

Specified by:

getOrientation in interface IAUCelestialBody

Overrides:

getOrientation in class AbstractCelestialBody

Returns:

the celestial body orientation

setOrientation

public void setOrientation(CelestialBodyOrientation celestialBodyIAUOrientation)

Set a celestial body IAU orientation to define the body frames.

Specified by:

setOrientation in interface CelestialBody

Overrides:

setOrientation in class AbstractCelestialBody

Parameters:

celestialBodyIAUOrientation - the celestial body IAU orientation

Throws:

IllegalArgumentException - if the celestial body orientation isn't an instance of CelestialBodyIAUOrientation

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 AbstractCelestialBody

Returns:

a string representation of the celestial point and its attributes