fr.cnes.sirius.patrius.bodies

Class UserCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

fr.cnes.sirius.patrius.bodies.UserCelestialBody

All Implemented Interfaces:

CelestialBody, CelestialPoint, 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 (if reference data are provided by IAU, prefer using UserIAUCelestialBody )

Since:

3.4

Version:

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

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.bodies.CelestialPoint

CelestialPoint.BodyNature

Field Summary

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

INERTIAL_FRAME, ROTATING_FRAME, SPACE

Fields inherited from interface fr.cnes.sirius.patrius.bodies.CelestialPoint

ECLIPTICJ2000_FRAME_NAME, EME2000_FRAME_NAME, ICRF_FRAME_NAME

Constructor Summary

Constructors

Constructor and Description
UserCelestialBody(String name, double gm, CelestialBodyFrame icrf, PVCoordinatesProvider aPVCoordinateProvider) Constructor with user-defined ICRF frame.
UserCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, BodyShape shape) Constructor.
UserCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, BodyShape shape, BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention) Constructor.
UserCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, GravityModel gravityModel, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, BodyShape shape) Constructor.
UserCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, GravityModel gravityModel, CelestialBodyOrientation orientation, Frame parentFrame, BodyShape shape, BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention) Constructor.

Method Summary

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

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

getGM, getGravityModel, getInertialFrame, getOrientation, getRotatingFrame, getShape, setGM, setGravityModel, setOrientation, setShape

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

getEclipticJ2000, getEME2000, getEphemeris, getICRF, getName, getNativeFrame, getPVCoordinates, setEphemeris

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.bodies.CelestialBody

getBodyNature, getName

Methods inherited from interface fr.cnes.sirius.patrius.bodies.CelestialPoint

getEclipticJ2000, getEME2000, getEphemeris, getICRF, setEphemeris

Methods inherited from interface fr.cnes.sirius.patrius.orbits.pvcoordinates.PVCoordinatesProvider

getNativeFrame, getPVCoordinates

Constructor Detail

UserCelestialBody

public UserCelestialBody(String name,
                         PVCoordinatesProvider aPVCoordinateProvider,
                         GravityModel gravityModel,
                         CelestialBodyOrientation orientation,
                         Frame parentFrame,
                         BodyShape shape,
                         BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention)

Constructor.

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.

gravityModel - gravitational attraction model

orientation - celestial body orientation

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

shape - body shape

spiceJ2000Convention - Spice convention

UserCelestialBody

public UserCelestialBody(String name,
                         PVCoordinatesProvider aPVCoordinateProvider,
                         GravityModel gravityModel,
                         CelestialBodyOrientation celestialBodyOrientation,
                         Frame parentFrame,
                         BodyShape shape)

Constructor.

SpiceJ2000ConventionEnum is set to ICRF.

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.

gravityModel - gravitational attraction model

celestialBodyOrientation - celestial body orientation

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

shape - body shape

UserCelestialBody

public UserCelestialBody(String name,
                         PVCoordinatesProvider aPVCoordinateProvider,
                         double gm,
                         CelestialBodyOrientation celestialBodyOrientation,
                         Frame parentFrame,
                         BodyShape shape,
                         BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention)

Constructor.

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²)

celestialBodyOrientation - celestial body orientation

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

shape - body shape

spiceJ2000Convention - Spice convention

UserCelestialBody

public UserCelestialBody(String name,
                         PVCoordinatesProvider aPVCoordinateProvider,
                         double gm,
                         CelestialBodyOrientation celestialBodyOrientation,
                         Frame parentFrame,
                         BodyShape shape)

Constructor.

SpiceJ2000ConventionEnum is set to ICRF.

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²)

celestialBodyOrientation - celestial body orientation

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

shape - body shape

UserCelestialBody

public UserCelestialBody(String name,
                         double gm,
                         CelestialBodyFrame icrf,
                         PVCoordinatesProvider aPVCoordinateProvider)

Constructor with user-defined ICRF frame.

Parameters:

name - name of the body

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

icrf - icrf frame centered on this body

aPVCoordinateProvider - coordinates provider

Method Detail

toString

public String toString()

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

Specified by:

toString in interface CelestialPoint

Overrides:

toString in class AbstractCelestialBody

Returns:

a string representation of the celestial point and its attributes