fr.cnes.sirius.patrius.bodies

Class AbstractCelestialPoint

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

All Implemented Interfaces:

CelestialPoint, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

AbstractCelestialBody, BasicCelestialPoint

public abstract class AbstractCelestialPoint
extends Object
implements CelestialPoint

Abstract implementation of the CelestialPoint interface.

This abstract implementation provides basic services that can be shared by most implementations of the CelestialPoint interface. It holds the gravitational attraction coefficient and build some body-centered frames automatically (ICRF, EME2000, etc.).

Since:

4.13

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
AbstractCelestialPoint(String name, double gm, CelestialBodyEphemeris ephemeris, CelestialBodyFrame icrf) Constructor with icrf frame.
AbstractCelestialPoint(String name, double gm, CelestialBodyEphemeris ephemeris, Frame parentFrame, BSPEphemerisLoader.SpiceJ2000ConventionEnum convention) Constructor with parent frame.
AbstractCelestialPoint(String name, double gm, Frame parentFrame, CelestialBodyEphemeris ephemeris) 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.
CelestialBodyFrame	getICRF() Get an ICRF, celestial point centered frame.
String	getName() Get the name of the celestial point.
Frame	getNativeFrame(AbsoluteDate date) Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
void	setEphemeris(CelestialBodyEphemeris ephemerisIn) Set an ephemeris to the celestial point.
void	setGM(double gmIn) Set a central attraction coefficient to the celestial point.
String	toString() Returns a string representation of the celestial point and its attributes.

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

getBodyNature

Constructor Detail

AbstractCelestialPoint

public AbstractCelestialPoint(String name,
                              double gm,
                              CelestialBodyEphemeris ephemeris,
                              Frame parentFrame,
                              BSPEphemerisLoader.SpiceJ2000ConventionEnum convention)

Constructor with parent frame.

Parameters:

name - name

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

ephemeris - ephemeris

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

convention - spice convention for BSP frames

AbstractCelestialPoint

public AbstractCelestialPoint(String name,
                              double gm,
                              CelestialBodyEphemeris ephemeris,
                              CelestialBodyFrame icrf)

Constructor with icrf frame.

Parameters:

name - name

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

ephemeris - ephemeris

icrf - icrf frame centered on this point

AbstractCelestialPoint

public AbstractCelestialPoint(String name,
                              double gm,
                              Frame parentFrame,
                              CelestialBodyEphemeris ephemeris)

Constructor.

Parameters:

name - name of the body

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

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

ephemeris - ephemeris

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

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

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

getName

public String getName()

Get the name of the celestial point.

Specified by:

getName in interface CelestialPoint

Returns:

name of the celestial point

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

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

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 Object

Returns:

a string representation of the celestial point and its attributes