fr.cnes.sirius.patrius.bodies

Class BSPCelestialBodyLoader

java.lang.Object

fr.cnes.sirius.patrius.bodies.AbstractJPLCelestialBodyLoader

fr.cnes.sirius.patrius.bodies.BSPCelestialBodyLoader

All Implemented Interfaces:

CelestialBodyLoader, Serializable

public class BSPCelestialBodyLoader
extends AbstractJPLCelestialBodyLoader

Loader for JPL ephemerides binary files BSP type.
It loads the whole CelestialPoint. For CelestialBodyEphemeris loader only, see dedicated class.

BSP ephemerides binary files contain ephemerides for any solar system body (depending on what is included in the file).

Since:

4.11.1

Author:

Emmanuel Bignon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BSPCelestialBodyLoader.SSBEphemeris Solar System Barycenter ephemeris specifically defined in its own class since SSB is not in BSP files, hence cannot be handled by BSPEphemerisLoader.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BSP_SUPPORTED_NAMES Default supported files name pattern for BSP files.
static String	EARTH_MOON Predefined name for Earth-Moon barycenter in BSP files.

Constructor Summary

Constructors

Constructor and Description
BSPCelestialBodyLoader(String supportedNamesIn) Create a loader for JPL ephemerides binary files (BSP type).

Method Summary

Modifier and Type	Method and Description
void	declareAsCelestialPoint(String name) Declare a name of a body as a CelestialPoint.
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.
static String	toSpiceName(String patriusName) Convert a PATRIUS body name to a SPICE body name.

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

buildDefaultBodyShape, getEphemerisLoader, getLoadedGravitationalCoefficient, getSupportedNames

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BSP_SUPPORTED_NAMES

public static final String DEFAULT_BSP_SUPPORTED_NAMES

Default supported files name pattern for BSP files.

See Also:

Constant Field Values

EARTH_MOON

public static final String EARTH_MOON

Predefined name for Earth-Moon barycenter in BSP files.

See Also:

Constant Field Values

Constructor Detail

BSPCelestialBodyLoader

public BSPCelestialBodyLoader(String supportedNamesIn)

Create a loader for JPL ephemerides binary files (BSP type).

Parameters:

supportedNamesIn - regular expression for supported files names

Method Detail

declareAsCelestialPoint

public void declareAsCelestialPoint(String name)

Declare a name of a body as a CelestialPoint.
Object will be built as CelestialPoint instead of CelestialBody.

Parameters:

name - a body name

loadCelestialPoint

public CelestialPoint loadCelestialPoint(String name)
                                  throws PatriusException

Load celestial point.

Parameters:

name - name of the celestial point

Returns:

loaded celestial point

Throws:

PatriusException - if the point cannot be loaded

loadCelestialBody

public CelestialBody loadCelestialBody(String name)
                                throws PatriusException

Load celestial body.

Parameters:

name - name of the celestial body

Returns:

loaded celestial body

Throws:

PatriusException - if the body cannot be loaded

getName

public String getName(String patriusName)

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

Parameters:

patriusName - PATRIUS body name

Returns:

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

toSpiceName

public static String toSpiceName(String patriusName)

Convert a PATRIUS body name to a SPICE body name.

Parameters:

patriusName - PATRIUS body name

Returns:

SPICE body name