fr.cnes.sirius.patrius.bodies

Interface CelestialPoint

All Superinterfaces:

PVCoordinatesProvider, Serializable

All Known Subinterfaces:

CelestialBody, IAUCelestialBody

All Known Implementing Classes:

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

public interface CelestialPoint
extends PVCoordinatesProvider

Interface for celestial points like Sun, Moon or solar system planets (without modeling the shape, orientation, etc).

Author:

Luc Maisonobe

See Also:

CelestialBodyFactory, CelestialBodyIAUOrientation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CelestialPoint.BodyNature Body nature.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ECLIPTICJ2000_FRAME_NAME EclipticJ2000 frame name.
static String	EME2000_FRAME_NAME EME2000 frame name.
static String	ICRF_FRAME_NAME ICRF frame name.

Method Summary

Modifier and Type	Method and Description
default CelestialPoint.BodyNature	getBodyNature() Getter for the celestial point nature.
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.
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 interface fr.cnes.sirius.patrius.orbits.pvcoordinates.PVCoordinatesProvider

getNativeFrame, getPVCoordinates

Field Detail

ICRF_FRAME_NAME

static final String ICRF_FRAME_NAME

ICRF frame name.

See Also:

Constant Field Values

EME2000_FRAME_NAME

static final String EME2000_FRAME_NAME

EME2000 frame name.

See Also:

Constant Field Values

ECLIPTICJ2000_FRAME_NAME

static final String ECLIPTICJ2000_FRAME_NAME

EclipticJ2000 frame name.

See Also:

Constant Field Values

Method Detail

getICRF

CelestialBodyFrame getICRF()
                    throws PatriusException

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.

Returns:

an inertially oriented, celestial point centered frame

Throws:

PatriusException - if frame cannot be retrieved

See Also:

CelestialBody.getRotatingFrame()

getEME2000

CelestialBodyFrame getEME2000()
                       throws PatriusException

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.

Returns:

an EME2000, celestial point centered frame

Throws:

PatriusException - if frame cannot be retrieved

getEclipticJ2000

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.

Returns:

an EclipticJ200, celestial point centered frame

Throws:

PatriusException - if frame cannot be retrieved

getName

String getName()

Get the name of the celestial point.

Returns:

name of the celestial point

getGM

double getGM()

Get the central attraction coefficient of the celestial point.

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

Returns:

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

setGM

void setGM(double gmIn)

Set a central attraction coefficient to the celestial point.

Parameters:

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

getEphemeris

CelestialBodyEphemeris getEphemeris()

Get the ephemeris of the celestial point.

Returns:

the ephemeris

setEphemeris

void setEphemeris(CelestialBodyEphemeris ephemerisIn)

Set an ephemeris to the celestial point.

Parameters:

ephemerisIn - the ephemeris

toString

String toString()

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

Overrides:

toString in class Object

Returns:

a string representation of the celestial point and its attributes

getBodyNature

default CelestialPoint.BodyNature getBodyNature()

Getter for the celestial point nature.

Returns:

the celestial point nature