fr.cnes.sirius.patrius.bodies

Class BasicCelestialPoint

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractCelestialPoint

fr.cnes.sirius.patrius.bodies.BasicCelestialPoint

All Implemented Interfaces:

CelestialPoint, PVCoordinatesProvider, Serializable

public class BasicCelestialPoint
extends AbstractCelestialPoint

Basic celestial point. It can be used to define any celestial point with:

• Its name
• A PVCoordinatesProvider or a CelestialBodyEphemeris providing body position-velocity through time

For user-defined Celestial bodies, use UserCelestialBody

Since:

4.13

Author:

Emmanuel Bignon

See Also:

Serialized Form

Nested Class Summary

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

CelestialPoint.BodyNature

Field Summary

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
BasicCelestialPoint(CelestialBodyFrame icrf, String name, double gm, CelestialBodyEphemeris ephemeris) Constructor.
BasicCelestialPoint(String name, double gm, CelestialBodyEphemeris ephemeris, CelestialBodyFrame icrf) Constructor.
BasicCelestialPoint(String name, double gm, CelestialBodyEphemeris ephemeris, Frame parentFrame, BSPEphemerisLoader.SpiceJ2000ConventionEnum convention) Constructor.
BasicCelestialPoint(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, Frame parentFrame) Constructor.
BasicCelestialPoint(String name, PVCoordinatesProvider aPVCoordinateProvider, double gm, Frame parentFrame, 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.AbstractCelestialPoint

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

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

getBodyNature

Constructor Detail

BasicCelestialPoint

public BasicCelestialPoint(String name,
                           PVCoordinatesProvider aPVCoordinateProvider,
                           double gm,
                           Frame parentFrame)

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

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

BasicCelestialPoint

public BasicCelestialPoint(String name,
                           PVCoordinatesProvider aPVCoordinateProvider,
                           double gm,
                           Frame parentFrame,
                           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²)

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

spiceJ2000Convention - Spice convention

BasicCelestialPoint

public BasicCelestialPoint(String name,
                           double gm,
                           CelestialBodyEphemeris ephemeris,
                           Frame parentFrame,
                           BSPEphemerisLoader.SpiceJ2000ConventionEnum convention)

Constructor.

Parameters:

name - name

gm - gravitational parameter

ephemeris - ephemeris

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

convention - spice convention for BSP frames

BasicCelestialPoint

public BasicCelestialPoint(String name,
                           double gm,
                           CelestialBodyEphemeris ephemeris,
                           CelestialBodyFrame icrf)

Constructor.

Parameters:

name - name

gm - gravitational parameter

ephemeris - ephemeris

icrf - icrf frame centered on this celestial point

BasicCelestialPoint

public BasicCelestialPoint(CelestialBodyFrame icrf,
                           String name,
                           double gm,
                           CelestialBodyEphemeris ephemeris)

Constructor.

Parameters:

icrf - ICRF frame

name - name

gm - gravitational parameter

ephemeris - ephemeris

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 AbstractCelestialPoint

Returns:

a string representation of the celestial point and its attributes