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

EME2000_FRAME_NAME, ICRF_FRAME_NAME, INERTIAL_FRAME_CONSTANT_MODEL, INERTIAL_FRAME_MEAN_MODEL, INERTIAL_FRAME_TRUE_MODEL, ROTATING_FRAME_CONSTANT_MODEL, ROTATING_FRAME_MEAN_MODEL, ROTATING_FRAME_TRUE_MODEL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	toString() Returns a string representation of the body and its attributes.

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

getEME2000, getEphemeris, getGM, getGravityModel, getIAUPole, getICRF, getInertialFrame, getName, getNativeFrame, getPVCoordinates, getRotatingFrame, getShape, setEphemeris, setGM, setGravityModel, 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,
                         GravityModel gravityModelIn,
                         IAUPole iauPole,
                         Frame parentFrame,
                         BodyShape shapeIn)

Build an instance and the underlying frame.

Parameters:

name - name of the body

aPVCoordinateProvider - Position-Velocity of celestial body. It is recommended that the native frame of aPVCoordinateProvider should be identical (or near) to the given parentFrame, in order to minimize the frames transformations.

gravityModelIn - gravitational attraction model

iauPole - IAU pole implementation

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

shapeIn - body shape

UserCelestialBody

public UserCelestialBody(String name,
                         PVCoordinatesProvider aPVCoordinateProvider,
                         double gm,
                         IAUPole iauPole,
                         Frame parentFrame,
                         BodyShape shapeIn)

Build an instance and the underlying frame.

Parameters:

name - name of the body

aPVCoordinateProvider - Position-Velocity of celestial body. It is recommended that the native frame of aPVCoordinateProvider should be identical (or near) to the given parentFrame, in order to minimize the frames transformations.

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

iauPole - IAU pole implementation

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

shapeIn - body shape

Method Detail

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