fr.cnes.sirius.patrius.bodies

Class UserCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

fr.cnes.sirius.patrius.bodies.UserCelestialBody

All Implemented Interfaces:

CelestialBody, PVCoordinatesProvider, Serializable

public class UserCelestialBody
extends AbstractCelestialBody

User-defined celestial body. It can be used to define any celestial body with:

• Its name
• A PVCoordinatesProvider providing body position-velocity through time
• Its gravitational constant
• Its pole motion (reference data are provided by IAU)

Since:

3.4

Version:

$Id: UserCelestialBody.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Field Summary

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

CONSTANT_ROTATING_FRAME_NAME, ICRF_FRAME_NAME, INERTIAL_EQUATOR_FRAME_NAME, MEAN_EQUATOR_FRAME_NAME, MEAN_ROTATING_FRAME_NAME, TRUE_EQUATOR_FRAME_NAME, TRUE_ROTATING_FRAME_NAME

Constructor Summary

Constructors

Constructor and Description
UserCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, IAUPole iauPole, Frame definingFrameIn, GeometricBodyShape shapeIn) Build an instance and the underlying frame.

Method Summary

Modifier and Type	Method and Description
Frame	getNativeFrame(AbsoluteDate date, Frame frame) Get the native frame, i.e.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.
PVCoordinatesProvider	getPVCoordinatesProvider() Get the PV coordinates provider.
String	toString() Returns a string representation of the body and its attributes.

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

getAttractionModel, getConstantRotatingFrame, getGM, getIAUPole, getICRF, getInertialEquatorFrame, getMeanEquatorFrame, getMeanRotatingFrame, getName, getShape, getTrueEquatorFrame, getTrueRotatingFrame, setAttractionModel, setGM, setIAUPole, setShape

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCelestialBody

public UserCelestialBody(String name,
                         PVCoordinatesProvider aPVCoordinateProvider,
                         double gm,
                         IAUPole iauPole,
                         Frame definingFrameIn,
                         GeometricBodyShape shapeIn)

Build an instance and the underlying frame.

Parameters:

name - name of the body

aPVCoordinateProvider - Position-Velocity of celestial body

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

iauPole - IAU pole implementation

definingFrameIn - frame in which celestial body coordinates are defined

shapeIn - body shape

Method Detail

getPVCoordinatesProvider

public PVCoordinatesProvider getPVCoordinatesProvider()

Get the PV coordinates provider.

Returns:

the PV coordinates provider

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

Specified by:

getPVCoordinates in class AbstractCelestialBody

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,
                            Frame frame)
                     throws PatriusException

Get the native frame, i.e. the raw frame in which PVCoordinates are expressed before transformation to user output frame. This native frame can be dependent on date and frame.

Parameters:

date - a date

frame - a frame

Returns:

the native frame

Throws:

PatriusException - thrown if native frame is undefined or unknown

toString

public String toString()

Returns a string representation of the body and its attributes.

Specified by:

toString in interface CelestialBody

Overrides:

toString in class AbstractCelestialBody

Returns:

a string representation of the body and its attributes