fr.cnes.sirius.patrius.bodies

Class UserIAUCelestialBody

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

fr.cnes.sirius.patrius.bodies.AbstractCelestialBody

fr.cnes.sirius.patrius.bodies.AbstractIAUCelestialBody

fr.cnes.sirius.patrius.bodies.UserIAUCelestialBody

All Implemented Interfaces:

CelestialBody, CelestialPoint, IAUCelestialBody, PVCoordinatesProvider, Serializable

public class UserIAUCelestialBody
extends AbstractIAUCelestialBody

User-defined IAU 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:

4.14

Author:

Thibaut BONIT

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.AbstractIAUCelestialBody

CONSTANT, INERTIAL_FRAME_CONSTANT_MODEL, INERTIAL_FRAME_MEAN_MODEL, INERTIAL_FRAME_TRUE_MODEL, MEAN, ROTATING_FRAME_CONSTANT_MODEL, ROTATING_FRAME_MEAN_MODEL, ROTATING_FRAME_TRUE_MODEL, TRUE

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
UserIAUCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, CelestialBodyIAUOrientation celestialBodyIAUOrientation, Frame parentFrame, BodyShape shape) Constructor.
UserIAUCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, CelestialBodyIAUOrientation celestialBodyIAUOrientation, Frame parentFrame, BodyShape shape, BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention) Constructor.
UserIAUCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, GravityModel gravityModel, CelestialBodyIAUOrientation celestialBodyIAUOrientation, Frame parentFrame, BodyShape shape) Constructor.
UserIAUCelestialBody(String name, PVCoordinatesProvider aPVCoordinateProvider, GravityModel gravityModel, CelestialBodyIAUOrientation iauOrientation, 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.AbstractIAUCelestialBody

getInertialFrame, getInertialFrame, getOrientation, getRotatingFrame, getRotatingFrame, setOrientation

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

getGM, getGravityModel, getShape, setGM, setGravityModel, 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, getGravityModel, getName, getShape, setGravityModel, setShape

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

getEclipticJ2000, getEME2000, getEphemeris, getGM, getICRF, setEphemeris, setGM

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

getNativeFrame, getPVCoordinates

Constructor Detail

UserIAUCelestialBody

public UserIAUCelestialBody(String name,
                            PVCoordinatesProvider aPVCoordinateProvider,
                            GravityModel gravityModel,
                            CelestialBodyIAUOrientation iauOrientation,
                            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

iauOrientation - celestial body IAU orientation

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

shape - body shape

spiceJ2000Convention - Spice convention

UserIAUCelestialBody

public UserIAUCelestialBody(String name,
                            PVCoordinatesProvider aPVCoordinateProvider,
                            GravityModel gravityModel,
                            CelestialBodyIAUOrientation celestialBodyIAUOrientation,
                            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

celestialBodyIAUOrientation - celestial body IAU orientation

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

shape - body shape

UserIAUCelestialBody

public UserIAUCelestialBody(String name,
                            PVCoordinatesProvider aPVCoordinateProvider,
                            double gm,
                            CelestialBodyIAUOrientation celestialBodyIAUOrientation,
                            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²)

celestialBodyIAUOrientation - celestial body IAU orientation

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

shape - body shape

spiceJ2000Convention - Spice convention

UserIAUCelestialBody

public UserIAUCelestialBody(String name,
                            PVCoordinatesProvider aPVCoordinateProvider,
                            double gm,
                            CelestialBodyIAUOrientation celestialBodyIAUOrientation,
                            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²)

celestialBodyIAUOrientation - celestial body IAU orientation

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

shape - body shape

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 AbstractIAUCelestialBody

Returns:

a string representation of the celestial point and its attributes