BSPEphemerisLoader (patrimoine de base SIRIUS 4.15 API)

java.lang.Object
- fr.cnes.sirius.patrius.bodies.bsp.BSPEphemerisLoader

All Implemented Interfaces:

CelestialBodyEphemerisLoader, JPLEphemerisLoader, DataLoader, Serializable
```
public class BSPEphemerisLoader
extends Object
implements JPLEphemerisLoader, DataLoader
```
Loader for the SPICE BSP format (type 2 and 3). For more details about the SPICE BSP format, please read the CSPICE documentation here
This reader implements the CelestialBodyEphemerisLoader interface and develops its own loading methods.

Since:

4.11.1

Author:

Emmanuel Bignon

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BSPEphemerisLoader.SpiceJ2000ConventionEnum
PATRIUS frame used as Spice J2000: either EME2000 or ICRF.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BSPEphemerisLoader.SpiceJ2000ConventionEnum` PATRIUS frame used as Spice J2000: either EME2000 or ICRF.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BSP_SUPPORTED_NAMES` Default supported files name pattern for BSP files.
`static double`	`MU_EARTH` Mu Earth.
`static double`	`MU_EARTH_MOON` Mu Earth Moon barycenter.
`static double`	`MU_JUPITER` Mu Jupiter.
`static double`	`MU_MARS` Mu Mars.
`static double`	`MU_MERCURY` Mu Mercury.
`static double`	`MU_MOON` Mu Moon.
`static double`	`MU_NEPTUNE` Mu Neptune.
`static double`	`MU_PLUTO` Mu Pluto.
`static double`	`MU_SATURN` Mu Saturn.
`static double`	`MU_SUN` Mu Sun.
`static double`	`MU_URANUS` Mu Uranus.
`static double`	`MU_VENUS` Mu Venus.
`static AbsoluteDate`	`SPICE_J2000_EPOCH` The basic spatial reference system for SPICE is the J2000 system.

Constructor Summary

Constructors
Constructor and Description

BSPEphemerisLoader(String supportedNames)
Constructor.

Constructors
Constructor and Description
`BSPEphemerisLoader(String supportedNames)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addSpiceBodyMapping(Map<Integer,String> bodyCodeNameMapping)` Add complementary (body code, body name) mapping which is not included in SPICE default mapping.
`static void`	`clearSpiceBodyMapping()` Clear the SPICE Body mapping
`String`	`getBodyLink()` Returns the BSP body name linked to PATRIUS frame tree.
`BSPEphemerisLoader.SpiceJ2000ConventionEnum`	`getConvention()` Getter for the Spice J2000 convention.
`double`	`getLoadedGravitationalCoefficient(PredefinedEphemerisType body)` Get the gravitational coefficient of a body.
`void`	`linkFramesTrees(Frame patriusFrame, String bspBodyName)` Link a BSP IAU frame (given its name) to a PATRIUS frame.
`CelestialBodyEphemeris`	`loadCelestialBodyEphemeris(String patriusName)` Load celestial body ephemeris.
`void`	`loadData(InputStream input, String name)` Load data from a stream.
`void`	`setSPICEJ2000Convention(BSPEphemerisLoader.SpiceJ2000ConventionEnum newConvention)` Setter for the Spice J2000 convention.
`boolean`	`stillAcceptsData()` Check if the loader still accepts new data.

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
  - MU_SUN
```
public static final double MU_SUN
```
    Mu Sun.
    
    See Also:
    
    Constant Field Values
  - MU_MERCURY
```
public static final double MU_MERCURY
```
    Mu Mercury.
    
    See Also:
    
    Constant Field Values
  - MU_VENUS
```
public static final double MU_VENUS
```
    Mu Venus.
    
    See Also:
    
    Constant Field Values
  - MU_EARTH_MOON
```
public static final double MU_EARTH_MOON
```
    Mu Earth Moon barycenter.
    
    See Also:
    
    Constant Field Values
  - MU_EARTH
```
public static final double MU_EARTH
```
    Mu Earth.
    
    See Also:
    
    Constant Field Values
  - MU_MOON
```
public static final double MU_MOON
```
    Mu Moon.
    
    See Also:
    
    Constant Field Values
  - MU_MARS
```
public static final double MU_MARS
```
    Mu Mars.
    
    See Also:
    
    Constant Field Values
  - MU_JUPITER
```
public static final double MU_JUPITER
```
    Mu Jupiter.
    
    See Also:
    
    Constant Field Values
  - MU_SATURN
```
public static final double MU_SATURN
```
    Mu Saturn.
    
    See Also:
    
    Constant Field Values
  - MU_URANUS
```
public static final double MU_URANUS
```
    Mu Uranus.
    
    See Also:
    
    Constant Field Values
  - MU_NEPTUNE
```
public static final double MU_NEPTUNE
```
    Mu Neptune.
    
    See Also:
    
    Constant Field Values
  - MU_PLUTO
```
public static final double MU_PLUTO
```
    Mu Pluto.
    
    See Also:
    
    Constant Field Values
  - SPICE_J2000_EPOCH
```
public static final AbsoluteDate SPICE_J2000_EPOCH
```
    The basic spatial reference system for SPICE is the J2000 system.
    This is an inertial reference frame in which the equations of motion for the solar system may be integrated.
    This reference frame is specified by the orientation of the earth's mean equator and equinox at a particular epoch --- the J2000 epoch.
    This epoch is Greenwich noon on January 1, 2000 Barycentric Dynamical Time (TDB).
- Constructor Detail
  - BSPEphemerisLoader
```
public BSPEphemerisLoader(String supportedNames)
```
    Constructor.
    
    Parameters:
    
    supportedNames - supported names
- Method Detail
  - loadCelestialBodyEphemeris
```
public CelestialBodyEphemeris loadCelestialBodyEphemeris(String patriusName)
                                                  throws PatriusException
```
    Load celestial body ephemeris.
    
    Specified by:
    
    loadCelestialBodyEphemeris in interface CelestialBodyEphemerisLoader
    
    Parameters:
    
    patriusName - body name known by Patrius
    
    Returns:
    
    loaded celestial body
    
    Throws:
    
    PatriusException - if the body, given its name, is not in the file
  - stillAcceptsData
```
public boolean stillAcceptsData()
```
    Check if the loader still accepts new data.
    This method is used to speed up data loading by interrupting crawling the data sets as soon as a loader has found the data it was waiting for. For loaders that can merge data from any number of sources (for example JPL ephemerides or Earth Orientation Parameters that are split among several files), this method should always return true to make sure no data is left over.
    
    Specified by:
    
    stillAcceptsData in interface DataLoader
    
    Returns:
    
    true while the loader still accepts new data
  - loadData
```
public void loadData(InputStream input,
                     String name)
              throws IOException,
                     PatriusException
```
    Load data from a stream.
    
    Specified by:
    
    loadData in interface DataLoader
    
    Parameters:
    
    input - data input stream
    
    name - name of the file (or zip entry)
    
    Throws:
    
    IOException - if data can't be read
    
    PatriusException - if some data is missing or if some loader specific error occurs
  - getLoadedGravitationalCoefficient
```
public double getLoadedGravitationalCoefficient(PredefinedEphemerisType body)
```
    Get the gravitational coefficient of a body. These coefficient values are coming from here.
    
    Specified by:
    
    getLoadedGravitationalCoefficient in interface JPLEphemerisLoader
    
    Parameters:
    
    body - body for which the gravitational coefficient is requested
    
    Returns:
    
    gravitational coefficient in m³/s²
  - setSPICEJ2000Convention
```
public void setSPICEJ2000Convention(BSPEphemerisLoader.SpiceJ2000ConventionEnum newConvention)
```
    Setter for the Spice J2000 convention.
    
    Parameters:
    
    newConvention - Spice J2000 convention
  - getConvention
```
public BSPEphemerisLoader.SpiceJ2000ConventionEnum getConvention()
```
    Getter for the Spice J2000 convention.
    
    Returns:
    
    the Spice J2000 convention
  - getBodyLink
```
public String getBodyLink()
```
    Returns the BSP body name linked to PATRIUS frame tree.
    
    Returns:
    
    the BSP body name linked to PATRIUS frame tree
  - linkFramesTrees
```
public void linkFramesTrees(Frame patriusFrame,
                            String bspBodyName)
                     throws PatriusException
```
    Link a BSP IAU frame (given its name) to a PATRIUS frame.
    For example, providing Mars ICRF frame and BSP name "MARS" will set BSP MARS body IAU frame as Mars ICRF frame.
    
    By default, BSP ICRF and PATRIUS ICRF are linked together (they are the same frame).
    
    Parameters:
    
    patriusFrame - an existing PATRIUS frame
    
    bspBodyName - a body from BSP file, its IAU frame will become the provided PATRIUS frame
    
    Throws:
    
    PatriusException - if body not in file
  - addSpiceBodyMapping
```
public static void addSpiceBodyMapping(Map<Integer,String> bodyCodeNameMapping)
```
    Add complementary (body code, body name) mapping which is not included in SPICE default mapping.
    Warning: this method should be called before any computation using BSPEphemerisLoader.
    
    SPICE body code-name mapping is defined statically and is therefore common to all BSPEphemerisLoader.
    
    Parameters:
    
    bodyCodeNameMapping - (body code, body name) mapping
  - clearSpiceBodyMapping
```
public static void clearSpiceBodyMapping()
```
    Clear the SPICE Body mapping

Class BSPEphemerisLoader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BSP_SUPPORTED_NAMES

MU_SUN

MU_MERCURY

MU_VENUS

MU_EARTH_MOON

MU_EARTH

MU_MOON

MU_MARS

MU_JUPITER

MU_SATURN

MU_URANUS

MU_NEPTUNE

MU_PLUTO

SPICE_J2000_EPOCH

Constructor Detail

BSPEphemerisLoader

Method Detail

loadCelestialBodyEphemeris

stillAcceptsData

loadData

getLoadedGravitationalCoefficient

setSPICEJ2000Convention

getConvention

getBodyLink

linkFramesTrees

addSpiceBodyMapping

clearSpiceBodyMapping