fr.cnes.sirius.patrius.bodies

Class UserCelestialBodyLoader

java.lang.Object

fr.cnes.sirius.patrius.bodies.UserCelestialBodyLoader

All Implemented Interfaces:

CelestialBodyLoader, Serializable

public class UserCelestialBodyLoader
extends Object
implements CelestialBodyLoader

Loader for UserCelestialBody or BasicCelestialPoint.

This loader is to be used in conjunction with CelestialBodyFactory.

Since:

4.13

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserCelestialBodyLoader(PVCoordinatesProvider pvCoordinatesProvider, double gm, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, BodyShape shape) Constructor.
UserCelestialBodyLoader(PVCoordinatesProvider pvCoordinatesProvider, double gm, CelestialBodyOrientation celestialBodyOrientation, Frame parentFrame, BodyShape shape, BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention) Complete constructor.

Method Summary

Modifier and Type	Method and Description
String	getName(String patriusName) Returns name of body as known by the loader corresponding to PATRIUS body name.
CelestialBody	loadCelestialBody(String name) Load celestial body.
CelestialPoint	loadCelestialPoint(String name) Load celestial point.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCelestialBodyLoader

public UserCelestialBodyLoader(PVCoordinatesProvider pvCoordinatesProvider,
                               double gm,
                               CelestialBodyOrientation celestialBodyOrientation,
                               Frame parentFrame,
                               BodyShape shape)

Constructor.

SpiceJ2000ConventionEnum is set to ICRF.

Parameters:

pvCoordinatesProvider - position-velocity of the body

gm - the value of the body's gravitational constant

celestialBodyOrientation - celestial body orientation (may be null)

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

shape - body shape (may be null)

UserCelestialBodyLoader

public UserCelestialBodyLoader(PVCoordinatesProvider pvCoordinatesProvider,
                               double gm,
                               CelestialBodyOrientation celestialBodyOrientation,
                               Frame parentFrame,
                               BodyShape shape,
                               BSPEphemerisLoader.SpiceJ2000ConventionEnum spiceJ2000Convention)

Complete constructor.

Parameters:

pvCoordinatesProvider - position-velocity of the body

gm - the value of the body's gravitational constant

celestialBodyOrientation - celestial body orientation (may be null)

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

shape - body shape (may be null)

spiceJ2000Convention - Spice convention

Method Detail

loadCelestialBody

public CelestialBody loadCelestialBody(String name)

Load celestial body.

Specified by:

loadCelestialBody in interface CelestialBodyLoader

Parameters:

name - name of the celestial body

Returns:

loaded celestial body

loadCelestialPoint

public CelestialPoint loadCelestialPoint(String name)
                                  throws PatriusException

Load celestial point.

Specified by:

loadCelestialPoint in interface CelestialBodyLoader

Parameters:

name - name of the celestial point

Returns:

loaded celestial point

Throws:

PatriusException - if the point cannot be loaded

getName

public String getName(String patriusName)

Returns name of body as known by the loader corresponding to PATRIUS body name.

Specified by:

getName in interface CelestialBodyLoader

Parameters:

patriusName - PATRIUS body name

Returns:

name of body as known by the loader corresponding to PATRIUS body name