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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Get the PVCoordinates of the body in the selected frame.

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

getBodyOrientedFrame, getGM, getInertiallyOrientedFrame, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCelestialBody

public UserCelestialBody(String name,
                 PVCoordinatesProvider aPVCoordinateProvider,
                 double gm,
                 IAUPole iauPole)

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

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

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