fr.cnes.sirius.patrius.bodies

Class AbstractCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

All Implemented Interfaces:

CelestialBody, PVCoordinatesProvider, Serializable

Direct Known Subclasses:

MeeusMoon, MeeusMoonStela, MeeusSun, UserCelestialBody

public abstract class AbstractCelestialBody
extends Object
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 attraction coefficient and build the body-centered frames automatically using the definitions of pole and prime meridianspecified by the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements of the Planets and Satellites (WGCCRE).

Author:

Luc Maisonobe

See Also:

IAUPole, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTANT_ROTATING_FRAME_NAME Constant rotating, body-centered frame name.
static String	ICRF_FRAME_NAME ICRF frame name.
static String	INERTIAL_EQUATOR_FRAME_NAME Inertially oriented, body-centered frame name.
static String	MEAN_EQUATOR_FRAME_NAME Mean equator, body-centered frame name.
static String	MEAN_ROTATING_FRAME_NAME Mean rotating, body-centered frame name.
static String	TRUE_EQUATOR_FRAME_NAME True equator, body-centered frame name.
static String	TRUE_ROTATING_FRAME_NAME True rotating, body-centered frame name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCelestialBody(Frame icrf, String nameIn, double gmIn, IAUPole iauPoleIn) Build an instance and the underlying frame.
protected	AbstractCelestialBody(String nameIn, double gmIn, IAUPole iauPoleIn, Frame definingFrameIn) Build an instance and the underlying frame.

Method Summary

Modifier and Type	Method and Description
AttractionModel	getAttractionModel() Get the attraction model of the body.
Frame	getConstantRotatingFrame() Get a body oriented, body centered frame taking into account only constant part of IAU pole data with respect to inertially-oriented frame.
double	getGM() Get the central attraction coefficient of the body.
IAUPole	getIAUPole() Get the IAU pole and primer meridians orientation.
Frame	getICRF() Get an ICRF, body centered frame.
Frame	getInertialEquatorFrame() Get an inertially oriented, body centered frame taking into account only constant part of IAU pole data with respect to ICRF frame.
Frame	getMeanEquatorFrame() Get an inertially oriented, body centered frame taking into account only constant and secular part of IAU pole data with respect to ICRF frame.
Frame	getMeanRotatingFrame() Get a body oriented, body centered frame taking into account constant and secular part of IAU pole data with respect to mean equator frame.
String	getName() Get the name of the body.
abstract PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
GeometricBodyShape	getShape() Get the geometric shape of the body.
Frame	getTrueEquatorFrame() Get an inertially oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to ICRF frame.
Frame	getTrueRotatingFrame() Get a body oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to true equator frame.
void	setAttractionModel(AttractionModel modelIn) Set an attraction model to the body.
void	setGM(double gmIn) Set a central attraction coefficient to the body.
void	setIAUPole(IAUPole iauPoleIn) Set a IAU Pole to define the body frames.
void	setShape(GeometricBodyShape shapeIn) Set a geometric shape to the body.
String	toString() Returns a string representation of the body 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.orbits.pvcoordinates.PVCoordinatesProvider

getNativeFrame

Field Detail

ICRF_FRAME_NAME

public static final String ICRF_FRAME_NAME

ICRF frame name.

See Also:

Constant Field Values

INERTIAL_EQUATOR_FRAME_NAME

public static final String INERTIAL_EQUATOR_FRAME_NAME

Inertially oriented, body-centered frame name.

See Also:

Constant Field Values

MEAN_EQUATOR_FRAME_NAME

public static final String MEAN_EQUATOR_FRAME_NAME

Mean equator, body-centered frame name.

See Also:

Constant Field Values

TRUE_EQUATOR_FRAME_NAME

public static final String TRUE_EQUATOR_FRAME_NAME

True equator, body-centered frame name.

See Also:

Constant Field Values

CONSTANT_ROTATING_FRAME_NAME

public static final String CONSTANT_ROTATING_FRAME_NAME

Constant rotating, body-centered frame name.

See Also:

Constant Field Values

MEAN_ROTATING_FRAME_NAME

public static final String MEAN_ROTATING_FRAME_NAME

Mean rotating, body-centered frame name.

See Also:

Constant Field Values

TRUE_ROTATING_FRAME_NAME

public static final String TRUE_ROTATING_FRAME_NAME

True rotating, body-centered frame name.

See Also:

Constant Field Values

Constructor Detail

AbstractCelestialBody

protected AbstractCelestialBody(String nameIn,
                                double gmIn,
                                IAUPole iauPoleIn,
                                Frame definingFrameIn)

Build an instance and the underlying frame.

Parameters:

nameIn - name of the body

gmIn - attraction coefficient (in m³/s²)

iauPoleIn - IAU pole implementation

definingFrameIn - frame in which celestial body coordinates are defined

AbstractCelestialBody

protected AbstractCelestialBody(Frame icrf,
                                String nameIn,
                                double gmIn,
                                IAUPole iauPoleIn)

Build an instance and the underlying frame.

Parameters:

icrf - ICRF frame

nameIn - name of the body

gmIn - attraction coefficient (in m³/s²)

iauPoleIn - IAU pole implementation

Method Detail

getName

public String getName()

Get the name of the body.

Specified by:

getName in interface CelestialBody

Returns:

name of the body

getICRF

public Frame getICRF()

Get an ICRF, body centered frame.

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

Specified by:

getICRF in interface CelestialBody

Returns:

an inertially oriented, body centered frame

See Also:

CelestialBody.getTrueRotatingFrame()

getInertialEquatorFrame

public Frame getInertialEquatorFrame()

Get an inertially oriented, body centered frame taking into account only constant part of IAU pole data with respect to ICRF frame.

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

Specified by:

getInertialEquatorFrame in interface CelestialBody

Returns:

an inertially oriented, body centered frame

getMeanEquatorFrame

public Frame getMeanEquatorFrame()

Get an inertially oriented, body centered frame taking into account only constant and secular part of IAU pole data with respect to ICRF frame.

Specified by:

getMeanEquatorFrame in interface CelestialBody

Returns:

an inertially oriented, body centered frame

getTrueEquatorFrame

public Frame getTrueEquatorFrame()

Get an inertially oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to ICRF frame.

Specified by:

getTrueEquatorFrame in interface CelestialBody

Returns:

an inertially oriented, body centered frame

getConstantRotatingFrame

public Frame getConstantRotatingFrame()

Get a body oriented, body centered frame taking into account only constant part of IAU pole data with respect to inertially-oriented frame.

The frame is always bound to the body center, and its axes have a fixed orientation with respect to the celestial body.

Specified by:

getConstantRotatingFrame in interface CelestialBody

Returns:

a body oriented, body centered frame

See Also:

CelestialBody.getInertialEquatorFrame()

getMeanRotatingFrame

public Frame getMeanRotatingFrame()

Get a body oriented, body centered frame taking into account constant and secular part of IAU pole data with respect to mean equator frame.

The frame is always bound to the body center, and its axes have a fixed orientation with respect to the celestial body.

Specified by:

getMeanRotatingFrame in interface CelestialBody

Returns:

a body oriented, body centered frame

See Also:

CelestialBody.getMeanEquatorFrame()

getTrueRotatingFrame

public Frame getTrueRotatingFrame()

Get a body oriented, body centered frame taking into account constant, secular and harmonics part of IAU pole data with respect to true equator frame.

The frame is always bound to the body center, and its axes have a fixed orientation with respect to the celestial body.

Specified by:

getTrueRotatingFrame in interface CelestialBody

Returns:

a body oriented, body centered frame

See Also:

CelestialBody.getInertialEquatorFrame()

getGM

public double getGM()

Get the central attraction coefficient of the body.

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

Specified by:

getGM in interface CelestialBody

Returns:

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

setGM

public void setGM(double gmIn)

Set a central attraction coefficient to the body.

Specified by:

setGM in interface CelestialBody

Parameters:

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

getIAUPole

public IAUPole getIAUPole()

Get the IAU pole and primer meridians orientation.

Specified by:

getIAUPole in interface CelestialBody

Returns:

the IAU Pole

setIAUPole

public void setIAUPole(IAUPole iauPoleIn)

Set a IAU Pole to define the body frames.

Specified by:

setIAUPole in interface CelestialBody

Parameters:

iauPoleIn - the IAU pole

getPVCoordinates

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

getAttractionModel

public AttractionModel getAttractionModel()

Get the attraction model of the body.

Specified by:

getAttractionModel in interface CelestialBody

Returns:

the attraction model

setAttractionModel

public void setAttractionModel(AttractionModel modelIn)

Set an attraction model to the body.

Specified by:

setAttractionModel in interface CelestialBody

Parameters:

modelIn - the attraction model

getShape

public GeometricBodyShape getShape()

Get the geometric shape of the body.

Specified by:

getShape in interface CelestialBody

Returns:

geometric shape of the body

setShape

public void setShape(GeometricBodyShape shapeIn)

Set a geometric shape to the body.

Specified by:

setShape in interface CelestialBody

Parameters:

shapeIn - the shape of the body

toString

public String toString()

Returns a string representation of the body and its attributes.

Specified by:

toString in interface CelestialBody

Overrides:

toString in class Object

Returns:

a string representation of the body and its attributes