fr.cnes.sirius.patrius.bodies

Class Earth

java.lang.Object

fr.cnes.sirius.patrius.bodies.Earth

All Implemented Interfaces:

CelestialBody, CelestialPoint, IAUCelestialBody, PVCoordinatesProvider, Serializable

public class Earth
extends Object
implements IAUCelestialBody

Earth body. Earth body is specific since it allows to match body frames with standard Earth boy frames (MOD, TOD, GCRF, etc.).

Since:

4.11.1

Author:

Emmanuel Bignon

See Also:

Serialized Form

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

Constructor Summary

Constructors

Constructor and Description
Earth(String name, double gm) Constructor.

Method Summary

Modifier and Type	Method and Description
CelestialBodyFrame	getEclipticJ2000() Get an Ecliptic J200, celestial point centered frame.
CelestialBodyFrame	getEME2000() Get an EME2000, celestial point centered frame.
CelestialBodyEphemeris	getEphemeris() Get the ephemeris of the celestial point.
double	getGM() Get the central attraction coefficient of the celestial point.
GravityModel	getGravityModel() Getter for the gravitational attraction model of the body.
CelestialBodyFrame	getICRF() Get an ICRF, celestial point centered frame.
CelestialBodyFrame	getInertialFrame(IAUPoleModelType iauPole) Getter for an inertially oriented, body centered frame.
String	getName() Getter for the name of the body.
Frame	getNativeFrame(AbsoluteDate date) Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.
CelestialBodyIAUOrientation	getOrientation() Getter for the celestial body IAU orientation and primer meridians orientation.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
CelestialBodyFrame	getRotatingFrame(IAUPoleModelType iauPole) Getter for a body oriented, body centered frame.
BodyShape	getShape() Getter for the geometric shape of the body.
void	setEphemeris(CelestialBodyEphemeris ephemerisIn) Set an ephemeris to the celestial point.
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 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 class java.lang.Object

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

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

getInertialFrame, getRotatingFrame

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

getBodyNature

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

toString

Constructor Detail

Earth

public Earth(String name,
             double gm)
      throws PatriusException

Constructor.

Parameters:

name - name

gm - gravitational parameter

Throws:

PatriusException - thrown if failed

Method Detail

getPVCoordinates

public PVCoordinates getPVCoordinates(AbsoluteDate date,
                                      Frame frame)
                               throws PatriusException

Get the PVCoordinates of the body in the selected frame.

Specified by:

getPVCoordinates in interface PVCoordinatesProvider

Parameters:

date - current date

frame - the frame where to define the position

Returns:

position/velocity of the body (m and m/s)

Throws:

PatriusException - if position cannot be computed in given frame

getEphemeris

public CelestialBodyEphemeris getEphemeris()

Get the ephemeris of the celestial point.

Specified by:

getEphemeris in interface CelestialPoint

Returns:

the ephemeris

setEphemeris

public void setEphemeris(CelestialBodyEphemeris ephemerisIn)

Set an ephemeris to the celestial point.

Specified by:

setEphemeris in interface CelestialPoint

Parameters:

ephemerisIn - the ephemeris

getNativeFrame

public Frame getNativeFrame(AbsoluteDate date)
                     throws PatriusException

Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.

Specified by:

getNativeFrame in interface PVCoordinatesProvider

Parameters:

date - a date

Returns:

the native frame

Throws:

PatriusException - thrown if native frame is undefined or unknown

getICRF

public CelestialBodyFrame getICRF()

Get an ICRF, celestial point centered frame.

The frame is always bound to the celestial point, and its axes have a fixed orientation with respect to other inertial frames.

Specified by:

getICRF in interface CelestialPoint

Returns:

an inertially oriented, celestial point centered frame

See Also:

CelestialBody.getRotatingFrame()

getEME2000

public CelestialBodyFrame getEME2000()

Get an EME2000, celestial point centered frame.

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

Specified by:

getEME2000 in interface CelestialPoint

Returns:

an EME2000, celestial point centered frame

getEclipticJ2000

public CelestialBodyFrame getEclipticJ2000()
                                    throws PatriusException

Get an Ecliptic J200, celestial point centered frame.

The frame is always bound to the celestial point center with constant rotation relative to the ICRF.

Specified by:

getEclipticJ2000 in interface CelestialPoint

Returns:

an EclipticJ200, celestial point centered frame

Throws:

PatriusException - if frame cannot be retrieved

getInertialFrame

public CelestialBodyFrame getInertialFrame(IAUPoleModelType iauPole)
                                    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:

iauPole - the type of IAUPole used for the frame

Returns:

an inertially oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getRotatingFrame

public CelestialBodyFrame getRotatingFrame(IAUPoleModelType iauPole)
                                    throws PatriusException

Getter for a body oriented, body centered frame.

Specified by:

getRotatingFrame in interface IAUCelestialBody

Parameters:

iauPole - the type of IAUPole used for the frame

Returns:

a body oriented, body centered frame

Throws:

PatriusException - if frame cannot be retrieved

getName

public String getName()

Getter for the name of the body.

Specified by:

getName in interface CelestialBody

Specified by:

getName in interface CelestialPoint

Returns:

name of the body

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

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

Parameters:

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

getOrientation

public CelestialBodyIAUOrientation getOrientation()

Getter for the celestial body IAU orientation and primer meridians orientation.

Specified by:

getOrientation in interface CelestialBody

Specified by:

getOrientation in interface IAUCelestialBody

Returns:

the celestial body IAU orientation

setOrientation

public void setOrientation(CelestialBodyOrientation celestialBodyOrientation)

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

Specified by:

setOrientation in interface CelestialBody

Parameters:

celestialBodyOrientation - the celestial body orientation